Predefinição:Documentation
Template documentation
|
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's Draft and test case pages. List of all subpages. |
| Usage of this template. |
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>Predefinição:T</noinclude> at the end of the template page.
Add <noinclude>Predefinição:T</noinclude> to transclude an alternative page from the /doc subpage.
Add <noinclude>Predefinição:T</noinclude> to change the category from Templates to something else.
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 and/or interwiki for the template itself -->
</includeonly><noinclude>
<!-- Any categories and/or interwiki for the template documentation -->
[[Category:Template documentation|{{PAGENAME}}]]
</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 and Template:T/piece templates. pt-br:Predefinição:Documentação