Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
en>Shirayuki (make documentation translatable) |
SheldonBole (talk | contribs) m (357 revisions imported: Import Template:Page in progress) |
||
| (50 intermediate revisions by 14 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
| − | <languages / | + | <languages/> |
</noinclude><includeonly>{{#switch:<translate></translate> | </noinclude><includeonly>{{#switch:<translate></translate> | ||
| = | | = | ||
| Line 11: | Line 11: | ||
{{Lua|Module:Documentation}} | {{Lua|Module:Documentation}} | ||
<translate> | <translate> | ||
| − | ==Usage== | + | <!--T:12--> |
| + | This template automatically displays a documentation box like the one you are seeing now, of which the content is transcluded from another page.</translate> | ||
| + | <translate> | ||
| + | <!--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. | ||
| + | |||
| + | ==Usage== <!--T:2--> | ||
| − | ===Customizing display=== | + | ===Customizing display=== <!--T:3--> |
| + | <!--T:4--> | ||
Overrides exist to customize the output in special cases: | Overrides exist to customize the output in special cases: | ||
</translate> | </translate> | ||
| − | * <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate>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.</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> | <translate> | ||
| − | ==Rationale== | + | ==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> | 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> | <translate> | ||
| − | It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [<tvar| | + | <!--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== | + | ==See also== <!--T:9--> |
</translate> | </translate> | ||
| − | * | + | * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate> |
* {{tim|Documentation}} | * {{tim|Documentation}} | ||
| − | * [[w:Wikipedia:Template documentation]] | + | * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate> |
}} | }} | ||
| − | + | [[Category:Formatting templates{{#translation:}}|Template documentation]] | |
[[Category:Template documentation{{#translation:}}| ]] | [[Category:Template documentation{{#translation:}}| ]] | ||
| − | [[Category: | + | </noinclude><includeonly>{{#if:{{{content|}}}| |
| − | </includeonly> | + | [[Category:Template documentation pages{{#translation:}}]] |
| + | }}</includeonly> | ||
Latest revision as of 08:09, 14 July 2020
Template documentation
 | Uses Lua: |
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).
