Template:Template-help: Difference between revisions

From The DarkMod Wiki
Jump to navigationJump to search
Tels (talk | contribs)
add parameter where and help to this template
Tels (talk | contribs)
fix help to not contain "<"
Line 4: Line 4:
=== Usage ===
=== Usage ===


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



Revision as of 16:41, 16 October 2007

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)