Template:Documentation/en: Difference between revisions

From Vigyanwiki
< Template:Documentation
m (1 revision imported)
mediawiki>FuzzyBot
(Updating to match new version of source page)
Line 10: Line 10:
==Usage==
==Usage==


===Customizing display===
===Customising display===


Overrides exist to customize 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.
* <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.



Revision as of 08:18, 20 August 2023

<languages/>

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 (see a developer's explanation).

See also

[[Category:Template documentation pages{{#translation:}}]]

[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]