Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
m (Reverted edits by Ianbirtwistle (talk) to last revision by [[User:Template>Pppery|Template>Pppery]]) Tag: Rollback |
m (1 revision imported) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
| − | + | </noinclude><includeonly>{{#switch: | |
| − | </noinclude><includeonly>{{#switch: | ||
| = | | = | ||
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | ||
| #default= | | #default= | ||
| − | {{#invoke: | + | {{#invoke:template=Template:Documentation|noshift=1}} |
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
{{documentation|content= | {{documentation|content= | ||
{{Lua|Module:Documentation}} | {{Lua|Module:Documentation}} | ||
| − | + | ||
<!--T:12--> | <!--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. | + | 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--> | <!--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. | 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. | ||
| Line 23: | Line 22: | ||
<!--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. |
| + | |||
| + | |||
==Rationale== <!--T:6--> | ==Rationale== <!--T:6--> | ||
<!--T:7--> | <!--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. | + | 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--> | <!--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]]). | 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--> | ==See also== <!--T:9--> | ||
| − | + | ||
| − | * | + | * <!--T:14--> [[w:Template:Documentation subpage]] |
* {{tim|Documentation}} | * {{tim|Documentation}} | ||
| − | * | + | * <!--T:11--> [[w:Wikipedia:Template documentation]] |
}} | }} | ||
| − | [[Category:Formatting templates | + | [[Category:Formatting templates|Template documentation]] |
| − | [[Category:Template documentation | + | [[Category:Template documentation| ]] |
</noinclude><includeonly>{{#if:{{{content|}}}| | </noinclude><includeonly>{{#if:{{{content|}}}| | ||
| − | [[Category:Template documentation pages | + | [[Category:Template documentation pages]] |
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 10:47, 13 August 2020
Template documentation
 | Uses Lua: |
This 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 [[<tvar|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
Usage[edit]
Customizing display[edit]
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[edit]
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|1>:en:Special:Diff/69888944</>|developer's explanation]]).