Documentation

Template documentation (for the above template, sometimes hidden or invisible) {{#if:

      |
      | 

| {{{1}}} | Documentation/doc }} | [[[{{#if: | {{{1}}} | Documentation/doc }}|view]]] [[{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=edit }} edit]] [[{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=history }} history]] [refresh] | [[{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=edit&preload=Template:Documentation/preload }} create]] }}

}}

{{#if: | {{{content}}} | {{#ifexist: {{#if: | {{{1}}} | Documentation/doc }}

 | Template:Tocright

Description

This template is used to insert descriptions on template pages.

Syntax

Add <noinclude>Template:T</noinclude> at the end of the template page.

Add <noinclude>Template:T</noinclude> to transclude an alternative page from the /doc subpage.

Usage

On the Template page

This is the normal format when used:

TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>

If your template is not a completed div or table, you may need to close the tags just before {{Documentation}} is inserted (within the noinclude tags).

A line break right before {{Documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.

On the documentation page

The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).

Normally, you will want to write something like the following on the documentation page:

==Description==
This template is used to do something.

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.

Note that the above example also uses the Template:T template.

 | : Help out by [{{fullurl:{{#if: 

| {{{1}}} | Documentation/doc }} | action=edit&preload=Template:Documentation/preload }} writing some]. {{#ifeq: | Template

      | There may also be documentation on [[w:c:templates:{{#if: 

| {{{1}}} | Documentation/doc }}|Wikia Templates]] which can be copied.

      }}{{
      #ifeq: Documentation | Template:Documentation/preload
      |
      | 
      }}
 }}

}}

{{#if:

      | Edit this page to change the above text. (What is this?)
      | {{#ifexist: {{#if: 

| {{{1}}} | Documentation/doc }} | The above text is transcluded from [[{{#if: | {{{1}}} | Documentation/doc }}]]; you can [{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=edit }} change it] or [{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=history }} view its history]. (How does this work?) | This template currently doesn't have any documentation; you can [{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=edit&preload=Template:Documentation/preload }} create it] if you know how the template is used. (What is this?) }}

      }}
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's {{#ifexist: {{#if: 

| {{{sandbox}}} | Documentation/sandbox }} | [[{{#if: | {{{sandbox}}} | Documentation/sandbox }}|sandbox]] ([{{fullurl:{{#if: | {{{sandbox}}} | Documentation/sandbox }} | action=edit }} edit] | diff) | sandbox ([{{fullurl:{{#if: | {{{sandbox}}} | Documentation/sandbox }} | action=edit&preload=Template:Documentation/preload-sandbox }} create] | [{{fullurl:{{#if: | {{{sandbox}}} | Documentation/sandbox }} | action=edit&preload=Documentation&summary=Create+sandbox+version+of+%5B%5BDocumentation%5D%5D }} mirror] ) }} and {{#ifexist: {{#if: | {{{testcases}}} | Documentation/testcases }} | [[{{#if: | {{{testcases}}} | Documentation/testcases }}|testcases]] ([{{fullurl:{{#if: | {{{testcases}}} | Documentation/testcases }} | action=edit }} edit]) | testcases ([{{fullurl:{{#if: | {{{testcases}}} | Documentation/testcases }} | action=edit&preload=Template:Documentation/preload-testcases }} create]) }} pages.{{#if: | |
Please add categories and interwikis to {{#ifexist: {{#if: | {{{1}}} | Documentation/doc }} | [[{{#if: | {{{1}}} | Documentation/doc }}]] | [{{fullurl:{{#if: | {{{1}}} | Documentation/doc }} | action=edit&preload=Template:Documentation/preload }} {{#if: | {{{1}}} | Documentation/doc }}] }}.

}} (View all subpages of this page.)