Template:Documentation/doc: Difference between revisions
en>桂月August Try to make a Doc for the template |
m 5 revisions imported |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | |||
This template is used to insert descriptions on template pages. | |||
==Syntax== | |||
Add <code><nowiki><noinclude></nowiki>{{tl|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page. | |||
* If <code><nowiki>notoc=1</nowiki></code>, the catalogue will not be displayed. | |||
* Use <code><nowiki>toc=</nowiki></code> will set the alignment of the catalogue. | |||
==Usage== | |||
===On the Template page=== | |||
This is the normal format when used: | |||
<pre> | |||
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> | |||
{{doc}}</noinclude> | |||
</pre> | |||
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{doc}}</nowiki></code> is inserted (within the noinclude tags).'' | |||
''A line break right before <code><nowiki>{{doc}}</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> | |||
==Description== | |||
This template is used to do something. | |||
==Syntax== | |||
Type <code>{{tl|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> | |||
</pre> | |||
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections. | |||
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | |||
Latest revision as of 22:20, 31 March 2025
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
or <noinclude>{{doc}}</noinclude> at the end of the template page.
- If
notoc=1, the catalogue will not be displayed. - Use
toc=will set the alignment of the catalogue.
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>
{{doc}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{doc}} is inserted (within the noinclude tags).
A line break right before {{doc}} 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>{{tl|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.