Template:Documentation: Difference between revisions

Latest revision as of 07:11, 23 December 2024

Template documentation

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 technical limitation of templates.

@@ Line 3: / Line 3: @@
 {{Lua|Module:Documentation}}
-<!--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.
+This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.
-<!--T:13--> It is intended for pages which are [[Help:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
+It is intended for pages which are [[Help:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
+==Usage==
-==Usage== <!--T:2-->
+===Customising display===
-===Customising display=== <!--T:3-->
-<!--T:4-->
 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> - <!--T:5--> change the text of the "documentation" heading. <!--T:10--> 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 [[Wikipedia:Template limits|technical limitation of templates]].
-==Rationale== <!--T:6-->
+<translate>
+==See also==
-<!--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.
+* [[Template:Documentation subpage]]
-<!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]].
+* [[Template:Documentation]]
+* [[Wikipedia:Template documentation]]
-==See also== <!--T:9-->
+}}
+[[Category:Formatting templates|Template documentation]]
-* <!--T:14--> [[Template:Documentation subpage]]
+[[Category:Template documentation| ]]
-* [[Template:Documentation]]
+</noinclude><includeonly>{{#if:{{{content|}}}|
-* <!--T:11--> [[Wikipedia:Template documentation]]
+[[Category:Template documentation pages]]
+}}</includeonly>