Help:Template documentation

Templates are a very powerful feature of MediaWiki, but they can be confusing to new users, and even experienced users can have difficulty making sense of the more complex ones. So, templates should have documentation to improve usability.

This documentation should explain what a template does and how to use it. It should be simple so someone without complete knowledge of how to use templates can use it correctly.

What should it include?
The documentation of some template should contain:
 * The purpose of the template; what it does/why it does that.
 * The parameters of the template.
 * Examples on how to use the templates.
 * TemplateData.
 * Related templates.
 * Categories and interwikis; templates with a separate /doc subpage handle these differently.

Adding the template
Adding documentation to templates is fairly easy. You do need to learn wikitext to do this.
 * 1) Go to a template, e.g. Template:Stub.
 * 2) Edit the page.
 * 3) At the bottom of the page, add this code:
 * 1) Save the page.

If documentation already exists, you should see text on the bottom, after the word Documentation. The display should be somewhat similar to: Note: The display may vary depending on the modifications you have made on your wiki.

Creating documentation
If you have a more advanced version of the documentation template, you might see this popup when you add the template without the /doc subpage:

You can click on the [create] link in the template, and it will preload the contents of Template:Documentation/preload. You can modify the editor text as you wish.

Otherwise, this will show: Template: /doc.

Click the link, and write down the suggested contents below:

What to add to the documentation
There are many formats for writing template documentation. Be sure to read your wiki's rules to see if there is a standardized guide for this.

If there isn't, feel free to copy the below formats. You can also customize/adopt them to your wiki.

Description
This template is used to do something...

Syntax
Template

Sample output
gives:

This is the most basic format for a template. It can be expanded, depending on what you want.

An alternative way to write this is by using description lists:
 * Description
 * This template is used to do something...


 * Syntax
 * Template


 * Sample output
 * gives:

Templates with parameters
For templates with parameters, it depends on what you want:

If the template is used on articles, adding TemplateData can be helpful, below the parameter list.

Add this code below :

Parameters

 * This parameter does abc.
 * This parameter does abc.

TemplateData
{}

Categories and interwikis
If you are using a /doc subpage, apply the following steps inside the subpage, not the template itself:

For the template
For categories, add: Replace  with the name of the category, such as Stubs.

For interwikis, add:

For the /doc subpage
For categories, add: Replace  with the name of the category, such as Stubs.

For interwikis, add:

Further help and feedback
fr:Aide:Documentation de modèle it:Aiuto:Documentazione per template tr:Yardım:Şablon belgelendirmesi