Template:Documentation: Difference between revisions

Latest revision as of 15:16, 3 July 2026

This template 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: </translate>

{{documentation|heading=}} - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>

Rationale

</translate> <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.</translate> <translate> It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>

@@ 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-->
-==Usage== <!--T:2-->
-===Customising display=== <!--T:3-->
+=== Customising display === <!--T:3-->
 <!--T:4-->
@@ Line 19: / Line 15: @@
 <translate>
-==Rationale== <!--T:6-->
+== 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>
@@ Line 25: / Line 21: @@
 <translate>
-==See also== <!--T:9-->
+== See also == <!--T:9-->
 </translate>
 * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>