Template:Documentation/doc: Difference between revisions
(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...") |
m (Tznkai moved page Peacekeepers of the Vast/Template:Documentation/doc to Template:Documentation/doc without leaving a redirect) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 39: | Line 39: | ||
{{templatename|input}} | {{templatename|input}} | ||
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | <noinclude>[[Category:Peacekeepers of the Vast-Template documentation|{{PAGENAME}}]]</noinclude> | ||
</pre> | </pre> | ||
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections. | 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. | Note that the above example also uses the [[Peacekeepers of the Vast/Template:T]] and [[Peacekeepers of the Vast/Template:T/piece]] templates. | ||
{{Important note|When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.}} | {{Important note|When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.}} | ||
| Line 51: | Line 51: | ||
This template's code was taken from [https://k6ka.miraheze.org/wiki/Template:Documentation/doc] | This template's code was taken from [https://k6ka.miraheze.org/wiki/Template:Documentation/doc] | ||
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | <noinclude>[[Category:Peacekeepers of the Vast-Template documentation|{{PAGENAME}}]]</noinclude> | ||
Latest revision as of 22:48, 12 December 2023
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>Template:T</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}}
Any categories for the template itself</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}}
<noinclude>[[Category:Peacekeepers of the Vast-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 Peacekeepers of the Vast/Template:T and Peacekeepers of the Vast/Template:T/piece templates.
Credits
This template's code was taken from [1]