Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m 9 revisions imported |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This template is used to | ;Description | ||
:This template is used to insert descriptions on template pages. | |||
;Syntax | |||
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the top of the template page. | |||
==General usage== | |||
<noinclude>[[Category:Template documentation| | ===On the Template page=== | ||
<pre><noinclude>{{documentation}} | |||
</noinclude>Template code | |||
<includeonly>Categories applied to pages using the template</includeonly> | |||
</pre> | |||
The line break before <code><nowiki><includeonly></nowiki></code> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <code><nowiki><includeonly></nowiki></code> to immediately after <code><nowiki></noinclude></nowiki></code>, hiding the template from view. | |||
===On the Template/doc page=== | |||
<pre> | |||
;Description | |||
:This template is used to do something. | |||
;Syntax | |||
:Type <code>{{t|templatename}}</code> somewhere. | |||
;Sample output | |||
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | |||
:{{templatename|foo}} | |||
<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 further usage information sections. | |||
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. | |||
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | |||
Latest revision as of 02:47, 19 February 2026
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the top of the template page.
General usage
[edit]On the Template page
[edit]<noinclude>{{documentation}}
</noinclude>Template code
<includeonly>Categories applied to pages using the template</includeonly>
The line break before <includeonly> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <includeonly> to immediately after </noinclude>, hiding the template from view.
On the Template/doc page
[edit];Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}
<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 further usage information sections.
Note that the above example also uses the Template:T and Template:T/piece templates.