Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
Template>ShakespeareFan00 |
m (1 revision imported) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | < | + | <noinclude> |
| + | </noinclude><includeonly>{{#switch: | ||
| + | | = | ||
| + | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | ||
| + | | #default= | ||
| + | {{#invoke:template=Template:Documentation|noshift=1}} | ||
| + | }}</includeonly><noinclude> | ||
| + | {{documentation|content= | ||
| − | + | {{Lua|Module:Documentation}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | } | ||
| − | + | <!--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 [[<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=== <!--T:3--> | |
| − | + | ||
| − | + | <!--T:4--> | |
| − | + | 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--> | |
| − | + | ||
| − | + | <!--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--> |
| − | {{#if:{{{content|}}}| | + | 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--> |
| − | + | ||
| − | + | * <!--T:14--> [[w:Template:Documentation subpage]] | |
| + | * {{tim|Documentation}} | ||
| + | * <!--T:11--> [[w:Wikipedia:Template documentation]] | ||
| + | |||
| + | }} | ||
| + | [[Category:Formatting templates|Template documentation]] | ||
| + | [[Category:Template documentation| ]] | ||
| + | </noinclude><includeonly>{{#if:{{{content|}}}| | ||
| + | [[Category:Template documentation pages]] | ||
| + | }}</includeonly> | ||
Latest revision as of 11: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]]).