Template:Documentation/doc: Difference between revisions
(Created page with "==Description== This template is used to insert descriptions on template pages. ==Syntax== Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowi...") |
No edit summary |
||
| Line 3: | Line 3: | ||
==Syntax== |
==Syntax== |
||
Add <code><nowiki><noinclude></nowiki>{{ |
Add <code><nowiki><noinclude></nowiki><nowiki>{{documentation}}</nowiki><nowiki></noinclude></nowiki></code> at the end of the template page. |
||
Add <code><nowiki><noinclude></nowiki>{{ |
Add <code><nowiki><noinclude></nowiki><nowiki>{{documentation|<documentation page>}}</nowiki><nowiki></noinclude></nowiki></code> to transclude an alternative page from the /doc subpage. |
||
==Usage== |
==Usage== |
||
| Line 31: | Line 31: | ||
==Syntax== |
==Syntax== |
||
Type <code>{{ |
Type <code>{{example|templatename}}</code> somewhere. |
||
==Samples== |
==Samples== |
||
| Line 45: | Line 45: | ||
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:T]] and [[Template:T/piece]] templates. |
|||
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
Revision as of 21:28, 17 January 2023
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Add <noinclude>{{documentation|<documentation page>}}</noinclude> 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>{{example|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.
