Template:Documentation

Documentation [edit]

This template should be used on all template pages to display and format the template's documentation. If the documentation does not exist, the template should be used anyway to link to it and add it to WantedTemplates. There are no parameters.

Template categories should be added to the documentation page, not the template page. Use {{documentation subpage}} at the top of the documentation page.

Formatting

The following formatting may be used on documentation pages for a consistent experience.

• Above any headings, briefly describe what the template does and link to any related templates or pages. If lengthier explanation is needed, create a new section as the first one.
• Use a section titled Parameters to describe the arguments that can be passed to the template, how they are used, and any default values.
  • In a bulleted list, put the name of the parameter in bold font, followed by a hyphen spaced from the surrounding text, and the related information.
    • Unnamed parameters can be unbolded and listed by their ordinal.
  • If the parameter is not required, place "(optional)" before the name.
• Include a section titled Examples that demonstrates how to use different parameters and combine them.
• For templates with a lot of parameters that are often copied and left blank (e.g. infoboxes), optionally include a section titled Skeleton with a blank version to be copied (including correct spacing).

The above documentation is transcluded from Template:Documentation/doc.