Template:Documentation/doc: Difference between revisions
imported>FANDOM No edit summary |
imported>Ziebster |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
Add <code>< | Add <code><nowiki>{{Documentation}}</nowiki></code> at the end of the template page. | ||
Add <code>< | Add <code><nowiki>{{Documentation|documentation page}}</nowiki></code> to transclude an alternative page from the /doc subpage. | ||
==Usage== | ==Usage== | ||
| Line 46: | Line 46: | ||
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:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | <includeonly>[[Category:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | ||
Latest revision as of 17:18, 22 December 2025
Description
This template is used to insert descriptions on template pages.
Syntax
Add {{Documentation}} at the end of the template page.
Add {{Documentation|documentation page}} to transclude an alternative page from the /doc subpage.
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 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.