Template:Template doc/doc

This template displays a "Template documentation" box just like you are seeing now.

Usage

Add to the main template at the end of the template code:

<noinclude>
 <!--
     PLEASE DO NOT ADD DOCUMENTATION/CATEGORIES/INTERWIKIS HERE
 -->
 {{Template doc}}
 <!--
     MAKE ADDITIONS TO THE /doc SUBPAGE INSTEAD, THANKS
 -->
 </noinclude>

or with a parameter: 1 = name of the documentation page.

Make sure the opening <noinclude> begins on the same line as the last character of the template code (or text), and not on a new line. Otherwise, extra space will be inserted below the template when it is used, which is usually not wanted.

Click the "edit" link, which points to the /doc subpage, and write documentation there.

Add categories and interwiki links to the /doc subpage inside <includeonly></includeonly>.

Limitation

A pipe character in the documentation page which is not inside double or triple braces or double brackets disturbs proper functioning of this template, because the content of that page is assigned to a template parameter. Use | instead.

If the documentation contains includeonly or noinclude tags within nowiki tags, replace the "<" with "&lt;".