Difference between revisions of "Template:Documentation"

From Confrontation.wiki
Jump to navigation Jump to search
en>Plastikspork
(Reducing transclusion depth per discussion on talk page)
m (2 revisions imported)
 
(162 intermediate revisions by 69 users not shown)
Line 1: Line 1:
<!--
<noinclude>
  Automatically add {{template sandbox notice}} when on a /sandbox page.
<languages/>
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
| <div style="clear: both;"></div>{{template sandbox notice}}
{{documentation|content=
}}<!--
  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/core
| preload = {{{preload|}}}  <!--Allow custom preloads-->
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}
| link box = {{{link box|}}}  <!--So "link box=off" works-->


| docpage =
{{Lua|Module:Documentation}}
  {{#if: {{{1|}}}
<translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
  | {{{1|}}}
<translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>
  | {{#switch: {{SUBJECTSPACE}}
  | {{ns:0}}
  | {{ns:File}}
  | {{ns:MediaWiki}}
  | {{ns:Category}} = {{TALKSPACE}}
  | #default = {{SUBJECTSPACE}}
  }}:{{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{BASEPAGENAME}}
  | #default = {{PAGENAME}}
  }}/doc
  }}
| doc exist =
  {{#ifexist:
    {{#if: {{{1|}}}
    | {{{1|}}}  <!--Other docname fed-->
    | {{#switch: {{SUBJECTSPACE}}
  | {{ns:0}}
  | {{ns:File}}
  | {{ns:MediaWiki}}
  | {{ns:Category}} = {{TALKSPACE}}
  | #default = {{SUBJECTSPACE}}
  }}:{{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{BASEPAGENAME}}
  | #default = {{PAGENAME}}
  }}/doc
    }}
  | yes
  }}
| docname fed =
  {{#if: {{{1|}}}
  | yes
  }}


| sandbox =
<translate>
  {{#switch: {{SUBJECTSPACE}}
==Usage== <!--T:2-->
  | {{ns:0}}
  | {{ns:File}}
  | {{ns:MediaWiki}}
  | {{ns:Category}} = {{TALKSPACE}}
  | #default = {{SUBJECTSPACE}}
  }}:{{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{BASEPAGENAME}}
  | #default = {{PAGENAME}}
  }}/sandbox
| testcases =
  {{#switch: {{SUBJECTSPACE}}
  | {{ns:0}}
  | {{ns:File}}
  | {{ns:MediaWiki}}
  | {{ns:Category}} = {{TALKSPACE}}
  | #default = {{SUBJECTSPACE}}
  }}:{{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{BASEPAGENAME}}
  | #default = {{PAGENAME}}
  }}/testcases


| template page =  
===Customizing display=== <!--T:3-->
  {{NAMESPACE}}:{{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{BASEPAGENAME}}
  | #default = {{PAGENAME}}
  }}


}}<!--End of green doc box--><noinclude>
<!--T:4-->
Overrides exist to customize the output in special cases:
</translate>
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>


<!-- Add categories and interwikis to the /doc subpage, not here! -->
<translate>
</noinclude>
==Rationale== <!--T:6-->
</translate>
<translate><!--T:7--> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links.</translate>
<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>
 
<translate>
==See also== <!--T:9-->
</translate>
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
* {{tim|Documentation}}
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
 
}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
[[Category:Template documentation{{#translation:}}| ]]
</noinclude><includeonly>{{#if:{{{content|}}}|
[[Category:Template documentation pages{{#translation:}}]]
}}</includeonly>

Latest revision as of 08:28, 19 July 2021


Template documentation

Template:Lua This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage

Customizing display

Overrides exist to customize the output in special cases:

  • {{documentation|heading=}} - change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.
Retrieved from "https://confrontation.wiki/index.php?title=Template:Documentation&oldid=2272"