Permanently protected template

Difference between revisions of "Template:Documentation"

From The HILLSIDE
Jump to navigation Jump to search
en>Paladox
(Undo revision 911233 by Paladox2017 (talk))
m (357 revisions imported: Import Template:Page in progress)
 
(94 intermediate revisions by 37 users not shown)
Line 1: Line 1:
<includeonly><!--
+
<noinclude>
  Automatically add {{template sandbox notice}} when on a /sandbox page.
+
<languages/>
-->{{#ifeq: {{SUBPAGENAME}} | sandbox |
+
</noinclude><includeonly>{{#switch:<translate></translate>
<div style="clear:both" />
+
| =
{{Template sandbox notice|{{{livepage|}}}}}
+
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
}}<!--
+
| #default=
   Start of green doc box.
+
   {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}}
-->{{Documentation/start box2
+
}}</includeonly><noinclude>
| preload = {{{preload|}}}<!-- Allow custom preloads -->
+
{{documentation|content=
| heading = {{{heading|¬}}}<!-- Empty but defined means no header -->
+
 
| heading-style = {{{heading-style|}}}
+
{{Lua|Module:Documentation}}
| content = {{{content|}}}
+
<translate>
| docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
+
<!--T:12-->
| 1 = {{{1|}}}<!-- Other docname, if fed -->
+
This template automatically displays a documentation box like the one you are seeing now, of which the content is transcluded from another page.</translate>
| lang = {{{lang|}}}
+
<translate>
| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 -->
+
<!--T:13-->
}}<!--
+
It is intended for pages which are [[<tvar|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
  Start load the /doc content:
+
 
  Note: The line break between this comment and the next line is necessary
+
==Usage== <!--T:2-->
  so an  "=== Heading ===" at start of doc subpage is correctly interpreted.
+
 
-->
+
===Customizing display=== <!--T:3-->
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}}
+
 
| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude -->
+
<!--T:4-->
| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }}
+
Overrides exist to customize the output in special cases:
| 0110 | 0111 = {{ {{{1|}}} }}
+
</translate>
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}}
+
* <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>
}}<!--
+
 
  End load the /doc content:
+
<translate>
  Note: The line break between this comment and the next line is necessary
+
==Rationale== <!--T:6-->
  so an "=== Heading ===" at end of doc subpage is correctly interpreted.
+
 
-->
+
<!--T:7-->
{{Documentation/end box2
+
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>
| preload = {{{preload|}}}<!-- Allow custom preloads -->
+
<translate>
| content = {{{content|}}}
+
<!--T:8-->
| link box = {{{link box|}}}<!-- So "link box=off" works -->
+
It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).
| docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
+
 
| 1 = {{{1|}}}<!-- Other docname, if fed -->
+
==See also== <!--T:9-->
| lang = {{{lang|}}}
+
</translate>
| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 -->
+
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
}}<!--
+
* {{tim|Documentation}}
  End of green doc box
+
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
--></includeonly><noinclude>
+
 
{{Documentation}}
+
}}
<!-- Add categories and interwikis to the /doc subpage, not here! -->
+
[[Category:Formatting templates{{#translation:}}|Template documentation]]
</noinclude>
+
[[Category:Template documentation{{#translation:}}| ]]
 +
</noinclude><includeonly>{{#if:{{{content|}}}|
 +
[[Category:Template documentation pages{{#translation:}}]]
 +
}}</includeonly>

Latest revision as of 08:09, 14 July 2020


Template documentation

This template automatically displays a documentation box like the one you are seeing now, of which the content is 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