Difference between revisions of "Template:Documentation"
L1ghtsword (talk | contribs) |
L1ghtsword (talk | contribs) |
||
| Line 3: | Line 3: | ||
This code was copied from Mediawiki Foundations site | This code was copied from Mediawiki Foundations site | ||
--> | --> | ||
| − | |||
<noinclude> | <noinclude> | ||
<languages/> | <languages/> | ||
| − | </noinclude> | + | </noinclude><includeonly>{{#switch:<translate></translate> |
| − | |||
| − | <includeonly>{{#switch:<translate></translate> | ||
| = | | = | ||
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} | ||
| #default= | | #default= | ||
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}} | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}} | ||
| − | }}</includeonly> | + | }}</includeonly><noinclude> |
| + | {{documentation|content= | ||
| − | < | + | {{Lua|Module:Documentation}} |
| − | {{Template:Documentation/ | + | <translate> |
| − | </ | + | <!--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.</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=== <!--T:3--> | ||
| + | |||
| + | <!--T:4--> | ||
| + | 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--> | ||
| + | |||
| + | <!--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> | ||
| + | <translate> | ||
| + | <!--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== <!--T:9--> | ||
| + | </translate> | ||
| + | * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate> | ||
| + | * {{tim|Documentation}} | ||
| + | * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate> | ||
| − | <includeonly>{{#if:{{{content|}}}| | + | }} |
| + | [[Category:Formatting templates{{#translation:}}|Template documentation]] | ||
| + | [[Category:Template documentation{{#translation:}}| ]] | ||
| + | </noinclude><includeonly>{{#if:{{{content|}}}| | ||
[[Category:Template documentation pages{{#translation:}}]] | [[Category:Template documentation pages{{#translation:}}]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 12:30, 26 August 2020
<languages/>
{{#switch:<translate></translate>
| =
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Documentation.tab.
| #default=
Script error: No such module "Template translation".
}}{{#if:Template: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>
- Template:Tim
- <translate> w:Wikipedia:Template documentation</translate>|
[[Category:Template documentation pages{{#translation:}}]] }} [[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]
