Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
Template documentation
| Line 3: | Line 3: | ||
{{documentation|content= | {{documentation|content= | ||
<!--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. | |||
<!--T:13--> It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not. | |||
==Usage== <!--T:2--> | ==Usage== <!--T:2--> | ||
| Line 13: | Line 13: | ||
<!--T:4--> | <!--T:4--> | ||
Overrides exist to customize the output in special cases: | Overrides exist to customize the output in special cases: | ||
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <!--T:5--> change the text of the "documentation" heading.<!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear. | |||
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - | |||
==Rationale== <!--T:6--> | ==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. | |||
<!--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]]). | |||
==See also== <!--T:9--> | ==See also== <!--T:9--> | ||
Revision as of 16:36, 1 December 2021
Template documentationThis template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes 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 [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).
See also
[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]