Permanently protected template

Difference between revisions of "Template:Documentation"

From The HILLSIDE
Jump to navigation Jump to search
meta>Verdy p
m (some doc pages need a few parameters (e.g. for feeding categories in their includeonly section, or for the actual template name to document))
m (357 revisions imported: Import Template:Page in progress)
 
(102 intermediate revisions by 38 users not shown)
Line 1: Line 1:
{{documentation/core2
+
<noinclude>
| heading = {{{heading|¬}}}<!--defined and empty means no header-->
+
<languages/>
| heading-style = {{{heading-style|}}}
+
</noinclude><includeonly>{{#switch:<translate></translate>
| link box = {{{link box|}}} <!--So "link box=off" works-->
+
| =
| template page =
+
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
  <!--The namespace is added in /core2-->
+
| #default=
  {{#switch: {{SUBPAGENAME}}
+
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}}
  | sandbox
+
}}</includeonly><noinclude>
  | testcases = {{BASEPAGENAME}}
+
{{documentation|content=
  | #default = {{PAGENAME}}
+
 
  }}
+
{{Lua|Module:Documentation}}
| docspace =
+
<translate>
  <!--Some namespaces must have the /doc, /sandbox and /testcases in talk space-->
+
<!--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}}
+
==Usage== <!--T:2-->
  }}
+
 
| content = {{{content|}}}
+
===Customizing display=== <!--T:3-->
| 1 = {{{1|}}} <!--Other docname, if fed-->
+
 
| {{#if: {{{2|}}} | 2 | <!--dummy--> }} = {{{2|}}} <!--Other parameters for doc page, if fed-->
+
<!--T:4-->
| {{#if: {{{3|}}} | 3 | <!--dummy--> }} = {{{3|}}} <!--Other parameters for doc page, if fed-->
+
Overrides exist to customize the output in special cases:
| {{#if: {{{4|}}} | 4 | <!--dummy--> }} = {{{4|}}} <!--Other parameters for doc page, if fed-->
+
</translate>
}}<noinclude>
+
* <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! ??? -->
+
 
</noinclude>
+
<translate>
 +
==Rationale== <!--T:6-->
 +
 
 +
<!--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|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