Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
(Created page with "<noinclude> {{under construction}} <languages/> </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> {{documentation|content= {{Lua|Module: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...") |
(no longer under construction) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> | |||
{{documentation|content= | {{documentation|content= | ||
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== | |||
==Usage== | |||
===Customising display=== | ===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== | |||
== | 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 [https://en.wikipedia.org/wiki/Help:Template_limits technical limitation of templates]. | ||
}} | }} | ||
[[Category: | [[Category:Templates]] | ||
</noinclude><includeonly>{{#if:{{{content|}}}| | </noinclude><includeonly>{{#if:{{{content|}}}| | ||
[[Category:Template documentation pages | [[Category:Template documentation pages]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 21:12, 31 October 2023
Template 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 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.