TemplateDoc:Doc/Template: Difference between revisions

From Halopedia, the Halo wiki

No edit summary
(Inserting TemplateDoc notice)
Line 1: Line 1:
{{Notice/TemplateDoc}}
==Usage==
==Usage==
This template is used to automatically insert the relevant template documentation into a template page. It will automatically transclude the associated page in the <code>TemplateDoc</code> namespace, or display a notice encouraging the user to create one, if there is no such page.
This template is used to automatically insert the relevant template documentation into a template page. It will automatically transclude the associated page in the <code>TemplateDoc</code> namespace, or display a notice encouraging the user to create one, if there is no such page.

Revision as of 19:06, June 4, 2020

This is a template documentation page!
You cannot edit the associated template from here. To do so, please see Template:Doc/Template instead!

Usage

This template is used to automatically insert the relevant template documentation into a template page. It will automatically transclude the associated page in the TemplateDoc namespace, or display a notice encouraging the user to create one, if there is no such page.

It should be transcluded at the end of all pages in the Template namespace, within <noinclude> blocks like so:

<includeonly> ... template code here ... </includeonly>
<noinclude>{{Documentation}} [[Category:Relevant template category]]</noinclude>

It does not require any arguments to be passed - it generate all of the necessary links and template transclusions automatically using MediaWiki magic words.

Example

Unfortunately, an example of this template in action cannot be shown on this page, because doing so would cause an infinite loop of transclusions. However, examples of this template's use should be abundant on other template pages. One such example can be seen on Template:*.