0
edits
This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.
(New page: ;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...) |
(This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
;Description | |||
:This template is used to insert descriptions on template pages. | |||
;Syntax | |||
:Type <code><noinclude>{{t|documentation}}</noinclude></code> at the top of the template page or <code><onlyinclude>''Template code''</onlyinclude>{{t|documentation}}</code>. | |||
;See also | |||
* {{t|Documentation2}} - for documenting template-like page in the main namespace. | |||
==General usage== | |||
===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><includeonly></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><includeonly></code> to immediately after <code></noinclude></code>, hiding the template from view. | |||
OR | |||
<pre>{{documentation}} | |||
<onlyinclude>Template code</onlyinclude> | |||
<includeonly>Categories applied to pages using the template</includeonly> | |||
</pre> | |||
===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. | |||
==Non-Template namespace usage== | |||
===On the Template page=== | |||
<pre><noinclude>{{documentation|ns=User}} | |||
</noinclude>Template code | |||
<includeonly>Categories applied to pages using the template</includeonly> | |||
</pre> | |||
The line break before <code><includeonly></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><includeonly></code> to immediately after <code><noinclude></code>, hiding the template from view. | |||
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]] | |||
[[ru:Шаблон:Документация]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | |||