| Site Notice |
|---|
| Due to recent vandalism, all edits performed by IPs and new users will be reviewed before being published. This means it might take some time for your edit to show up. New accounts also have to be confirmed before being created. If you have any questions, contact one of the staff members on their talk page, or on the Discord server. |
Template:Documentation/doc: Difference between revisions
m 1 revision imported |
m fixed template typo |
||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
Add <code><nowiki><noinclude></nowiki>{{ | Add <code><nowiki><noinclude></nowiki>{{tl|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. | ||
==Usage== | ==Usage== | ||
| Line 27: | Line 27: | ||
==Syntax== | ==Syntax== | ||
Type <code>{{ | Type <code>{{tl|templatename}}</code> somewhere. | ||
==Samples== | ==Samples== | ||
| Line 41: | Line 41: | ||
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections. | 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: | Note that the above example also uses the [[Template:Tl]] template. | ||
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | <includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | ||
Latest revision as of 11:22, 7 June 2016
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.
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 Template/doc page[edit]
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>{{tl|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:Tl template.