Difference between revisions of "Template:Documentation"

From RobotX
Jump to navigation Jump to search
Wikimedia Commons>4nn1l2
m (Changed protection level for "Template:Documentation": downgraded protection level per consensus ([Edit=Allow only template editors and administrators] (indefinite) [Move=Allow only template editors and administrators] (indefinite)))
Mediawiki>Shirayuki
(fix category for Template:Documentation's translation pages)
Line 1: Line 1:
<onlyinclude>{{Autotranslate/clone_2
+
<noinclude>
|base    = Documentation
+
<languages />
|lang    = {{{lang|{{int:Lang}} }}}
+
</noinclude><includeonly>{{#switch:<translate></translate>
|1      = {{{1|{{SUBJECTPAGENAME}}/doc}}}
+
| =
|2      = {{{heading|{{{2|}}} }}}
+
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
|content = {{{content|}}}
+
| #default=
}}</onlyinclude><noinclude>
+
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}}
<!-- {{Autotranslate/clone_2}} is identical to {{Autotranslate}} and it is used to avoid "Warning: This page calls Template:Autotranslate which causes a template loop (an infinite recursive call). "-->
+
}}</includeonly><noinclude>
 +
{{documentation|content=
  
{{Documentation}}
+
{{Lua|Module:Documentation}}
 +
<translate>
 +
==Usage== <!--T:2-->
  
</noinclude>
+
===Customizing display=== <!--T:3-->
 +
 
 +
<!--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>
 +
 
 +
<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|url>{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}}</> developer's explanation]).
 +
 
 +
==See also== <!--T:9-->
 +
</translate>
 +
* {{tiw|documentation subpage}}
 +
* {{tim|Documentation}}
 +
* [[w:Wikipedia:Template documentation]]
 +
 
 +
}}
 +
[[Category:Formatting templates{{#translation:}}|Template documentation]]
 +
</noinclude><includeonly>
 +
{{#ifeq:{{translatable}}|Template:Documentation|
 +
[[Category:Template documentation{{#translation:}}| ]]
 +
}}
 +
{{#if:{{{content|}}}|
 +
[[Category:Template documentation pages{{#translation:}}]]
 +
}}
 +
</includeonly>

Revision as of 22:47, 26 November 2019


Template documentation

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