Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Documentation: Difference between revisions

Template page
m 1 revision imported: may be useful
wikidata>Daask
Remove documentation comment for Category:Templates without documentation in pages without this category.
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>
  Automatically add {{template sandbox notice}} when on a /sandbox page.
<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>
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
<div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;">
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
{{#if:{{{1|{{{content|}}}}}} |{{{1|{{{content}}}}}} |{{/doc}}}}
}}<!--
</div></includeonly><noinclude>{{documentation|1=
  Automatically add {{pp-template}} to protected templates.
-->{{template other
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
  | {{pp-template|docusage=yes}}
  | {{#if: {{PROTECTIONLEVEL:edit}}
    | {{pp-template|docusage=yes}}
    | <!--Not protected, or only semi-move-protected-->
    }}
  }}
}}<!--
  Start of green doc box.
-->{{documentation/start box2
| preload = {{{preload|}}}   <!--Allow custom preloads-->
| heading = {{{heading|¬}}}   <!--Empty but defined means no header-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}


;Goal
<!--Some namespaces must have the /doc, /sandbox and /testcases
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.
    in talk space-->
| docspace = {{documentation/docspace}}


;Usage
| 1 = {{{1|}}}  <!--Other docname, if fed-->
The template can be used with two parameters and must be put between &lt;noinclude&gt;&lt;/noinclude&gt;.
<pre><nowiki>&lt;noinclude&gt;{{</nowiki>documentation|1=


Explanation of purpose and use of the template
<!--The namespace is added in /start box2-->
| template page = {{documentation/template page}}


<nowiki>}}
}}<!-- Start content --><!--
&lt;/noinclude&gt;</nowiki></pre>
  Start load the /doc content:
<pre><nowiki>&lt;noinclude&gt;{{</nowiki>documentation|content=
  Note: The line breaks between this comment and the next line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110
| 1111 = {{{content|}}}
| 0110 | 0111 = {{ {{{1}}} }}
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
| 0000 | 0100 | 0010 | 0101 =
}}
<!--
  End load the /doc content:
  Note: The line breaks between this comment and the previous line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->{{documentation/end box2
| preload = {{{preload|}}}  <!--Allow custom preloads-->
| content = {{{content|}}}
| link box = {{{link box|}}}  <!--So "link box=off" works-->


Explanation of purpose and use of the template
<!--Some namespaces must have the /doc, /sandbox and /testcases
    in talk space-->
| docspace = {{documentation/docspace}}


<nowiki>}}
| 1 = {{{1|}}}   <!--Other docname, if fed-->
&lt;/noinclude&gt;</nowiki></pre>


;It is suggested to always use the following parts in the template information:
<!--The namespace is added in /end box2-->
*Goal
| template page = {{documentation/template page}}
*Usage
 
;And if applicable:
}}<!--
*Default values
  End of green doc box
*Related templates
--><includeonly>{{#ifexist:{{#titleparts:{{FULLPAGENAME}}|1}}/doc
For clarity, headings are best preceded by a semicolon (;).
|
}}[[Category:Documentation templates]]</noinclude>
|[[Category:Templates without documentation]]
<!--
  Maintenance category for templates containing the documentation template
  but without having an associated documentation page
-->}}</includeonly><noinclude>
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>
Cookies help us deliver our services. By using our services, you agree to our use of cookies.