Difference between revisions of "Template:Documentation"

Jump to navigation Jump to search
m
2 revisions imported
en>WOSlinker
(copy over preload feature as per edit request on talk page)
m (2 revisions imported)
 
(163 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/core2
| 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-->


<!--Some namespaces must have the /doc, /sandbox and /testcases
{{Lua|Module:Documentation}}
    in talk space-->
<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>
| docspace =
<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}}
  }}


| 1 = {{{1|}}}  <!--Other docname, if fed-->
<translate>
==Usage== <!--T:2-->


<!--The namespace is added in /core2-->
===Customizing display=== <!--T:3-->
| template page =
  {{#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>

Navigation menu