Permanently protected template

Difference between revisions of "Template:Documentation"

From The HILLSIDE
Jump to navigation Jump to search
en>Davidgothberg
(Calling /core2 for more parameter preprocessing, it in turn calls /core. Since adding smarter namespace handling, and stuff for debug-reporting to a category. See talk, "Subject space vs talk space".)
m (357 revisions imported: Import Template:Page in progress)
 
(188 intermediate revisions by 88 users not shown)
Line 1: Line 1:
<!--
+
<noinclude>
  Automatically add {{template sandbox notice}} when on a /sandbox page.
+
<languages/>
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
+
</noinclude><includeonly>{{#switch:<translate></translate>
| <div style="clear: both;"></div>{{template sandbox notice}}
+
| =
}}<!--
+
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
  Automatically add {{pp-template}} to protected templates.
+
| #default=
-->{{template other
+
   {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}}
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
+
}}</includeonly><noinclude>
  | {{pp-template}}
+
{{documentation|content=
  | {{#if: {{PROTECTIONLEVEL:edit}}
 
    | {{pp-template}}
 
    | <!--Not protected, or only semi-move-protected-->
 
    }}
 
  }}
 
}}<!--
 
   Start of green doc box.
 
-->{{documentation/core2
 
| 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>
| docspace =
+
<!--T:12-->
  {{#switch: {{SUBJECTSPACE}}
+
This template automatically displays a documentation box like the one you are seeing now, of which the content is transcluded from another page.</translate>
  | {{ns:0}}
+
<translate>
  | {{ns:File}}
+
<!--T:13-->
  | {{ns:MediaWiki}}
+
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.
  | {{ns:Category}} = {{TALKSPACE}}
 
  | #default = {{SUBJECTSPACE}}
 
  }}
 
  
<!--For debug purposes-->
+
==Usage== <!--T:2-->
| not-docspace =
 
  {{#switch: {{SUBJECTSPACE}}
 
  | {{ns:0}}
 
  | {{ns:File}}
 
  | {{ns:MediaWiki}}
 
  | {{ns:Category}} = {{SUBJECTSPACE}}
 
  | #default = {{TALKSPACE}}
 
  }}
 
  
| 1 = {{{1|}}}  <!--Other docname, if fed-->
+
===Customizing display=== <!--T:3-->
  
<!--The namespace is added in /core2-->
+
<!--T:4-->
| template page =
+
Overrides exist to customize the output in special cases:
  {{#switch: {{SUBPAGENAME}}
+
</translate>
  | sandbox
+
* <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>
  | testcases = {{BASEPAGENAME}}
 
  | #default = {{PAGENAME}}
 
  }}
 
  
}}<!--End of green doc box--><noinclude>
+
<translate>
 +
==Rationale== <!--T:6-->
  
<!-- Add categories and interwikis to the /doc subpage, not here! -->
+
<!--T:7-->
</noinclude>
+
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|1>:en:Special:Diff/69888944</>|developer's explanation]]).
 +
 
 +
==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: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