×
Create a new article
Write your page title here:
We currently have 34 articles on Mijopedia. Type your article name above or click on one of the titles below and start writing!



Template:Documentation

Revision as of 06:00, 3 December 2024 by MeowyCats2 (talk | contribs) (Created page with "<includeonly>{| class="article-table plainlinks" style="width:100%;" role="complementary" |- style="font-size:18px;" ! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div> |- | ''Note: portions of the template sample may not be visible without values provided.'' |- | View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. (About template documentation) |-...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description[edit]

This template is used to insert descriptions on template pages.

Syntax[edit]

Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.

Add <noinclude>{{Documentation|<documentation page>}}</noinclude> to transclude an alternative page from the /doc subpage.

Usage[edit]

On the Template page[edit]

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[edit]

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.