Template:Template-help

From The DarkMod Wiki
Revision as of 15:22, 22 November 2022 by Datiswous (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

This template generates a help message for other templates.

Usage

Include this template inside a <noinclude> </noinclude> section of any template that is used for categorizing pages like so:

{{{template-help|name=Foo|sort=foo|where=bottom}}}

Parameters

  1. The name parameter is the name of the template that includes the help.
  2. The sort parameter for this template influences the place where the template will be sorted in the Template category.
  3. the where parameter should be either top or bottom.


Example Description
{{{template-help|name=foo}}} default sorting order based on template name
{{{template-help|name=foo|sort=Foo}}} an template foo goes under "F" (specifically "Foo")
{{{template-help|name=foo|sort=Foo|where=top}}} The template help instructs the user to include the template at the top (default is bottom)