Template:Documentation: Difference between revisions

From PZwiki
m (1 revision: Hidden key template)
 
m (update colors to use css variables instead)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<!--
<includeonly><onlyinclude><!--
  Automatically add {{template sandbox notice}} when on a /sandbox page.
--><div style="clear: both; border: var(--border-mw);"><!--
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
}}<!--
  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|}}}


<!--Some namespaces must have the /doc, /sandbox and /testcases
  --><div style="padding: 0.5em; background:var(--background-mw-heading); border-bottom: var(--border-mw);"><!--
     in talk space-->
     --><span style="font-size:80%;" class="plainlinks">[[{{fullurl:{{FULLPAGENAME}}/doc}} <span title="view the documentation">view</span>]]  [[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} <span title="edit the documentation">edit</span>]]  [[{{fullurl:{{FULLPAGENAME}}/doc|action=history}} <span title="documentation history">history</span>]]  [[{{fullurl:{{FULLPAGENAME}}|action=purge}} <span title="purge this page">purge</span>]]</span><!--
| docspace = {{documentation/docspace}}
    --> '''Template documentation'''<!--


| 1 = {{{1|}}}   <!--Other docname, if fed-->
   --></div><!--


<!--The namespace is added in /start box2-->
  --><div style="margin: 0; padding: 10px; background:var(--background-mw)"><!--
| template page = {{documentation/template page}}
    -->{{#ifexist: {{FULLPAGENAME}}/doc<!--
  -->|
{{:{{FULLPAGENAME}}/doc}}<!--


}}<!-- Start content --><!--
  -->| '''This template doesn't have any documentation yet!''' Help out by <span class="plainlinks">[{{fullurl:{{FULLPAGENAMEE}}/doc|action=edit&preload=Template:Documentation/preload}} writing some]</span>.<!--
  Start load the /doc content:
  -->[[Category:Templates without documentation|{{PAGENAME}}]]<!--
  Note: The line breaks between this comment and the next line are necessary
 
  so  "=== Headings ===" at the start and end of docs are interpreted.
    -->}}<!--
-->
  --></div><!--
{{#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-->


<!--Some namespaces must have the /doc, /sandbox and /testcases
  --><div style="background:var(--background-mw-heading); text-align: right; padding: 0.5em; border-top: var(--border-mw);">''Documentation transcluded from [[{{FULLPAGENAME}}/doc]].<br>Editors can experiment in this template's sandbox ([[{{FULLPAGENAME}}/sandbox|create]])''</div><!--
    in talk space-->
--></div><!--
| docspace = {{documentation/docspace}}
--></onlyinclude></includeonly>
 
{{Deprecated|Documentation/sandbox}}
| 1 = {{{1|}}<!--Other docname, if fed-->
{{Documentation}}
 
[[Category:Template documentation| ]]
<!--The namespace is added in /end box2-->
| template page = {{documentation/template page}}
 
}}<!--
  End of green doc box
--><noinclude>
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

Latest revision as of 07:45, 30 March 2024

Imbox content.png
This template is deprecated.
This template will eventually be removed. Please use Template:Documentation/sandbox instead.
[view] [edit] [history] [purge] Template documentation
The {{Documentation}} template is used to contain the documented information and instructions of a certain template from a /doc subpage.

Usage

To use this template, {{Documentation}} should be added to the template inside a <noinclude> tag, so the documentation isn't transcluded along with the template. Then add the documentation to the /doc page, and it will be added to the template. The documentation page should include the {{Documentation subpage}} template, so it is added to the appropriate documentation category.

Example

<!--Last line of your template code--><noinclude>
{{Documentation}}
</noinclude>

See also

Documentation transcluded from Template:Documentation/doc.
Editors can experiment in this template's sandbox (create)