Editing Template:Documentation/doc
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| 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>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. | Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. | ||
| − | == Usage == | + | ==Usage== |
| − | === On the Template page === | + | ===On the Template page=== |
This is the normal format when used: | This is the normal format when used: | ||
| Line 27: | Line 19: | ||
''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.'' | ''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>{{t|templatename}}</code> somewhere. | Type <code>{{t|templatename}}</code> somewhere. | ||
| − | == Usage == | + | ==Usage== |
A more indepth description of when, how this template is used. | A more indepth description of when, how this template is used. | ||
| − | == Samples == | + | ==Samples== |
<code><nowiki>{{templatename|input}}</nowiki></code> | <code><nowiki>{{templatename|input}}</nowiki></code> | ||
| Line 47: | Line 39: | ||
{{templatename|input}} | {{templatename|input}} | ||
| − | == See Also == | + | ==See Also== |
A list of all related links. | A list of all related links. | ||
<includeonly>Any categories for the template itself</includeonly> | <includeonly>Any categories for the template itself</includeonly> | ||
| − | <noinclude>[[Category:Template | + | <noinclude>[[Category:Template Documentation|{{PAGENAME}}]]</noinclude> |
</pre> | </pre> | ||
| Line 58: | Line 50: | ||
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:Documentation | + | <includeonly>[[Category:Templates]][[Category:Template Documentation]]</includeonly> |
| − | <noinclude>[[Category:Template | + | <noinclude>[[Category:Template Documentation]]</noinclude> |