Template:Documentation/doc: Difference between revisions
No edit summary |
(Updated categories.) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== |
== Description == |
||
This template is used to insert descriptions on template pages. |
This template is used to insert descriptions on template pages. |
||
==Syntax== |
== Syntax == |
||
Add <code><nowiki><noinclude></nowiki>{{ |
Add <code><nowiki><noinclude></nowiki>{{T|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. |
||
==Usage== |
== Usage == |
||
| ⚫ | |||
| ⚫ | |||
This is the normal format when used: |
This is the normal format when used: |
||
| Line 15: | Line 14: | ||
</pre> |
</pre> |
||
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{ |
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{Documentation}}</nowiki></code> is inserted (within the noinclude tags).'' |
||
''A line break right before <code><nowiki>{{ |
''A line break right before <code><nowiki>{{Documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.'' |
||
===On the Template/doc page=== |
=== On the Template/doc page === |
||
Normally, you will want to write something like the following on the documentation page: |
Normally, you will want to write something like the following on the documentation page: |
||
<pre> |
<pre> |
||
==Description== |
== Description == |
||
This template is used to do something. |
This template is used to do something. |
||
==Syntax== |
== Syntax == |
||
Type <code>{{ |
Type <code>{{T|Templatename}}</code> somewhere. |
||
==Samples== |
== Samples == |
||
<code><nowiki>{{ |
<code><nowiki>{{Templatename|input}}</nowiki></code> |
||
results in... |
results in... |
||
{{ |
{{Templatename|input}} |
||
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
| Line 43: | Line 42: | ||
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. |
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. |
||
<includeonly>[[Category: |
<includeonly>[[Category:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> |
||
Latest revision as of 00:27, 24 June 2023
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.