Template:Documentation/doc: Difference between revisions
sims>Duskey m (added category) |
sims>K6ka (Created page with " ==Description== This template is used to insert descriptions on template pages. ==Syntax== Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></now...") |
||
Line 1:
:This template is used to insert documentation on template pages.▼
;Syntax▼
:Type <code><noinclude>{{t|documentation}}</noinclude></code> at the end of the template page.▼
==
▲
==Usage==
===On the Template page===
This is the normal format when used:
<pre>
{{documentation}}</noinclude>
</pre>
''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>{{documentation}}</nowiki></code> 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:
<pre>
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...▼
==Samples==
:{{templatename|foo}}▼
results in...
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
</pre>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>▼
▲Note that the above example also uses {{t|T}}.
▲[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
|
Revision as of 22:01, 11 May 2017
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.