Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
m 1 revision imported Tags: Mobile edit Mobile web edit |
m 1 revision imported: may be useful |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{# | <includeonly>__NOEDITSECTION__ | ||
<div class="sjabdocnote" style="color:grey; text-align:center; margin-top:1em;"><small>'''The template description below will not be displayed when the template is placed.'''</small></div> | |||
<div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;">'''Template''': {{navbar|{{PAGENAME}}|mini=1}} ─ '''Template/doc''': {{navbar|{{PAGENAME}}/doc|mini=1}}</div> | |||
<div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;"> | |||
{{#if:{{{1|{{{content|}}}}}} |{{{1|{{{content}}}}}} |{{/doc}}}} | |||
</div></includeonly><noinclude>{{documentation|1= | |||
;Goal | |||
This template can be used to add information about the purpose and use of a template. It also serves to create a separation between a template and the information about use that is not included when a template is placed. | |||
;Usage | |||
The template can be used with two parameters and must be put between <noinclude></noinclude>. | |||
<pre><nowiki><noinclude>{{</nowiki>documentation|1= | |||
Explanation of purpose and use of the template | |||
<nowiki>}} | |||
</noinclude></nowiki></pre> | |||
<pre><nowiki><noinclude>{{</nowiki>documentation|content= | |||
Explanation of purpose and use of the template | |||
<nowiki>}} | |||
</noinclude></nowiki></pre> | |||
;It is suggested to always use the following parts in the template information: | |||
*Goal | |||
*Usage | |||
;And if applicable: | |||
*Default values | |||
*Related templates | |||
For clarity, headings are best preceded by a semicolon (;). | |||
}}[[Category:Documentation templates]]</noinclude> | |||
Latest revision as of 19:05, 6 October 2024
The template description below will not be displayed when the template is placed.
Template: ─ Template/doc:
- Goal
This template can be used to add information about the purpose and use of a template. It also serves to create a separation between a template and the information about use that is not included when a template is placed.
- Usage
The template can be used with two parameters and must be put between <noinclude></noinclude>.
<noinclude>{{documentation|1=
Explanation of purpose and use of the template
}}
</noinclude>
<noinclude>{{documentation|content=
Explanation of purpose and use of the template
}}
</noinclude>
- It is suggested to always use the following parts in the template information
- Goal
- Usage
- And if applicable
- Default values
- Related templates
For clarity, headings are best preceded by a semicolon (;).