Difference between revisions of "Template:Documentation/doc"
Jump to navigation
Jump to search
m (project category overhaul - changing category linking & update content) |
|||
| (6 intermediate revisions by 3 users 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== | + | Depends on: |
| + | * {{t|template other}} | ||
| + | * {{t|pp-template}} | ||
| + | * {{t|documentation/start box2}} | ||
| + | * {{t|documentation/end box2}} | ||
| + | * {{t|documentation/docspace}} | ||
| + | * {{t|documentation/template page}} | ||
| + | |||
| + | == 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 19: | Line 27: | ||
''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 39: | Line 47: | ||
{{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 50: | Line 58: | ||
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 | + | <noinclude>[[Category:Template documentation]]</noinclude> |
Latest revision as of 23:51, 4 April 2023
Description[edit]
This template is used to insert descriptions on template pages.
Depends on:
- {{template other}}
- {{pp-template}}
- {{documentation/start box2}}
- {{documentation/end box2}}
- {{documentation/docspace}}
- {{documentation/template page}}
Syntax[edit]
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Usage[edit]
On the Template page[edit]
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[edit]
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.
== Usage ==
A more indepth description of when, how this template is used.
== Samples ==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
== See Also ==
A list of all related links.
<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above header sections. You may also add other header sections as required.
Note that the above example also uses the Template:T and Template:T/piece templates.