Difference between revisions of "Template:Documentation"
Tag: 2017 source edit |
m (Reverted edits by Ianbirtwistle (talk) to last revision by [[User:Template>Pppery|Template>Pppery]]) Tag: Rollback |
||
| Line 1: | Line 1: | ||
| + | <noinclude> | ||
| + | <languages/> | ||
| + | </noinclude><includeonly>{{#switch:<translate></translate> | ||
| + | | = | ||
| + | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | ||
| + | | #default= | ||
| + | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}} | ||
| + | }}</includeonly><noinclude> | ||
| + | {{documentation|content= | ||
{{Lua|Module:Documentation}} | {{Lua|Module:Documentation}} | ||
| − | + | <translate> | |
<!--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.</translate> |
| − | + | <translate> | |
<!--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 14: | Line 23: | ||
<!--T:4--> | <!--T:4--> | ||
Overrides exist to customize the output in special cases: | 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--> | ==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.</translate> |
| − | + | <translate> | |
<!--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--> | ||
| − | + | </translate> | |
| − | * <!--T:14--> [[w:Template:Documentation subpage]] | + | * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate> |
* {{tim|Documentation}} | * {{tim|Documentation}} | ||
| − | * <!--T:11--> [[w:Wikipedia:Template documentation]] | + | * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate> |
}} | }} | ||
| − | [[Category:Formatting templates|Template documentation]] | + | [[Category:Formatting templates{{#translation:}}|Template documentation]] |
| − | [[Category:Template documentation| ]] | + | [[Category:Template documentation{{#translation:}}| ]] |
</noinclude><includeonly>{{#if:{{{content|}}}| | </noinclude><includeonly>{{#if:{{{content|}}}| | ||
| − | [[Category:Template documentation pages]] | + | [[Category:Template documentation pages{{#translation:}}]] |
}}</includeonly> | }}</includeonly> | ||
Revision as of 01:33, 31 July 2020
<languages/>
 | Uses Lua: |
<translate> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate> <translate> 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
Customizing display
Overrides exist to customize the output in special cases: </translate>
- {{documentation|heading=}} - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>
<translate>
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.</translate> <translate> It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).
See also
</translate>
- <translate> w:Template:Documentation subpage</translate>
- m:Template:Documentation
- <translate> w:Wikipedia:Template documentation</translate>
[[Category:Template documentation pages{{#translation:}}]][[Category:Template documentation pages{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]