Template:Documentation: Difference between revisions

Revision as of 08:52, 13 February 2025

{{documentation|content=

Uses 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 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 ---

@@ Line 1: / Line 1: @@
 <noinclude>
-<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>
+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><!--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>
+It is intended for pages which are Transcluded in other pages, i.e. templates, whether in the template namespace or not.
-<translate>
-==Usage== <!--T:2-->
-===Customising display=== <!--T:3-->
+==Usage==
+===Customising display===
-<!--T:4-->
 Overrides exist to customise 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>
+* <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== <!--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>
+==Rationale==
-<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>
+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 ---
-<translate>
-==See also== <!--T:9-->
-</translate>
-* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
-* {{tim|Documentation}}
-* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
-}}
+==See also==
-[[Category:Formatting templates{{#translation:}}|Template documentation]]
+[[Special:Help]]
-[[Category:Template documentation{{#translation:}}| ]]
-</noinclude><includeonly>{{#if:{{{content|}}}|
-[[Category:Template documentation pages{{#translation:}}]]
-}}</includeonly>