Template:Documentation: Difference between revisions

Help

Newer edit →

VisualWikitext

Revision as of 03:14, 29 March 2022

Template documentation

[view] [edit] [history] [purge]

Lua logo

Uses Lua:

Module:Documentation

File:OOjs UI icon notice-warning.svg

This template is used in system messages.
Changes to it can cause immediate changes to the MediaWiki user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space.The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

Usage

Customizing display

Overrides exist to customize 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, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

@@ Line 1: / Line 1: @@
-<noinclude>
+{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude>
-<languages/>
+<!-- Add categories to the /doc subpage -->
-</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
+</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 which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>
-<translate>
-==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-->
-</translate>
-<translate><!--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 and categories.</translate>
-<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>
-<translate>
-==See also== <!--T:9-->
-</translate>
-* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
-* {{tim|Documentation}}
-* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
-}}
-[[Category:Formatting templates{{#translation:}}|Template documentation]]
-[[Category:Template documentation{{#translation:}}| ]]
-</noinclude><includeonly>{{#if:{{{content|}}}|
-[[Category:Template documentation pages{{#translation:}}]]
-}}</includeonly>