Template:Documentation

From BattleMaster Wiki
Jump to navigation Jump to search
Template-info.svg Template Documentation
This documentation is transcluded from Template:Documentation/doc.

ExamplesSandbox

Intro

In order to ensure the maximum usability of a template, wiki contributors must be able to use the template. Since some templates are quite complex, or may be counter-intuitive, documentation should be provided to show the users the available parameters, provide examples, explain any possible problems, etc.

This template is designed to make adding documentation to your template easier. It automatically creates links to a documentation page for your template, as well as links to a sandbox page for testing template modifications, and a page for examples showing the template in use.

Usage

To added the Documentation template to your page, add the following to your template:

  • <noinclude>{{Documentation}}</noinclude>

If your template already has a <noinclude> section, then add {{Documentation}} to the existing <noinclude> section. You can then transfer the non-included material to the newly linked documentation subpage.