Template:Documentation/doc

Template page
< Template:Documentation
Revision as of 18:47, 6 April 2022 by Aeywoo (talk | contribs) (Created Template:Documentation/doc.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page (usually PAGENAME/doc). It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Use this template only if the template page you're using it on has a documentation at Template:TEMPLATENAME/doc. If not, create this page before you proceed.

Usage

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

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used).

The template usually transcludes content from PAGENAME/doc. If you want to transclude content from a different page, specify its pagetitle behind a |, like this:

<noinclude>{{Documentation|Other page}}</noinclude>

The template transcludes now the content from Other page.

Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <includeonly> </includeonly> tags.

If you add a sandbox or testcases at Template:TEMPLATENAME/sandbox and Template:TEMPLATENAME/testcases, links to these pages will be displayed automatically at the top of the documentation box

Cookies help us deliver our services. By using our services, you agree to our use of cookies.