Template:Documentation: Difference between revisions

Help

Revision as of 01:47, 3 May 2025

Template documentation
Note: portions of the template sample may not be visible without values provided.
View or edit this documentation. (About template documentation)
Editors can experiment in this template's sandbox and test case pages.

Template:Documentation is used to give descriptions to template pages so they can be used more easily.

how to use

Add <noinclude>{{documentation}}</noinclude> at the end of the template page.

Add <noinclude>{{documentation|<documentation page>}}</noinclude> to transclude an alternative page from the /doc subpage.

@@ Line 1: / Line 1: @@
-<noinclude>
+<includeonly>{| class="article-table" style="width:100%;" role="complementary"
-<languages/>
+|- style="font-size:18px;"
-</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
+! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
-{{documentation|content=
+|-
+| ''Note: portions of the template sample may not be visible without values provided.''
-{{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>
+| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
-<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>
+|-
+| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/Draft|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages.
-<translate>
+|}
-== Usage == <!--T:2-->
+<div style="margin:0 1em;">
+{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>
-=== Customising display === <!--T:3-->
+{{Documentation}}</noinclude>
-<!--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>
-== 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>