Template:Documentation: Difference between revisions
From Wings of Fire: The New World Wiki
not needed Tag: wikieditor |
don't need this, we're not on wikipedia |
||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> | </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> | ||
{{documentation|content= | {{documentation|content= | ||
{{Lua|Module:Documentation}} | {{Lua|Module:Documentation}} | ||
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 [[Help:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not. | |||
===Customising display=== | ==Usage== | ||
===Customising display=== | |||
Overrides exist to customise the output in special cases: | Overrides exist to customise the output in special cases: | ||
< | * <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> -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== | |||
==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 and categories. | |||
It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[w:en:Special:Diff/69888944|developer's explanation]]). | |||
==See also== | |||
* [[w:Template:Documentation subpage]] | |||
* | |||
* {{tim|Documentation}} | * {{tim|Documentation}} | ||
* | * [[w:Wikipedia:Template documentation]] | ||
}} | }} |
Latest revision as of 00:43, 26 November 2024
Template documentation
File:Lua-Logo.svg | This template 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 transcluded in other pages, i.e. templates, whether in the template namespace or not.
Usage
Customising display
Overrides exist to customise 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 and categories. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).