ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.
Difference between revisions of "Template:Documentation/doc"
From ModEnc
(Doc for instructions of the templates.) |
m (Do not use Template:T any more) |
||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
| − | Add <code><nowiki><noinclude></nowiki>{{ | + | Add <code><nowiki><noinclude></nowiki>{{tl|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl|doc}}<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 40: | Line 40: | ||
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. | ||
| − | |||
| − | |||
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | <includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | ||
Revision as of 10:11, 23 August 2021
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
or <noinclude>{{doc}}</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>
{{doc}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{doc}} is inserted (within the noinclude tags).
A line break right before {{doc}} 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>{{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.
