Template:Documentation: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<div id="documentation" style="clear: both; margin: 1em 0 0 0; border: 1px solid #aaa; background-color: #000033; padding: 1em;"> |
|||
<includeonly>{| class="article-table" style="width:100%;" |
|||
<div style="float: right;" class="plainlinks">{{#switch:{{PROTECTIONLEVEL:edit}} |
|||
|- style="font-size:18px;" |
|||
| sysop = [[[{{TALKPAGENAME}}|talk]]] |
|||
| ⚫ | |||
| #default = [[{{fullurl:{{FULLPAGENAMEE}}/doc}} view]] [[{{fullurl:{{FULLPAGENAMEE}}/doc|action=edit}} edit]] [[{{fullurl:{{FULLPAGENAMEE}}/doc|action=purge}} purge]] |
|||
|- |
|||
}} </div> |
|||
| ''Note: the template above may sometimes be partially or fully invisible.'' |
|||
{{:{{{1|{{FULLPAGENAME}}/doc}}}}}<includeonly> |
|||
|- |
|||
{{#ifeq:{{PROTECTIONLEVEL:edit}}|sysop|{{protected|small=1}}|}}</includeonly><noinclude></div> |
|||
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) |
|||
| ⚫ | |||
|} |
|||
</noinclude> |
|||
<div style="margin:0 1em;"> |
|||
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> |
|||
Revision as of 14:43, 14 August 2020
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.
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 Template/doc page
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|{{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.