Template:Documentation: Difference between revisions

Latest revision as of 22:23, 22 January 2021

{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}{{#if:Template:Lua <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> <translate> It is intended for pages which are [[<tvar|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>

Usage

Customizing display

Overrides exist to customize 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, categories, and interwiki links.</translate> <translate> It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).</translate>

@@ Line 1: / Line 1: @@
 <noinclude>
-<!-- Need noinclude here to support future full protection. -->
+<languages/>
-{{ #ifeq: {{SUBPAGENAME}} | sandbox | {{Template sandbox notice}} }}
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
-{{intricate}}
+{{documentation|content=
-{{
-  #ifeq: {{FULLPAGENAME}} | Template:Documentation |
+{{Lua|Module:Documentation}}
-  {{Mergingfrom|Template doc|date=November 2007}}
+<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|1>Special:MyLanguage/Help:Transclusion</>|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, categories, and interwiki links.</translate>
+<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar|1>:en:Special:Diff/69888944</>|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>
 }}
-</noinclude><div class="template-documentation" style="margin-top:1em;">{{#if:{{{heading|defaultnotblank}}}|<div style="padding-bottom:3px; border-bottom:1px solid #aaa; margin-bottom:1ex;">
+[[Category:Formatting templates{{#translation:}}|Template documentation]]
-<span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]</span>
+[[Category:Template documentation{{#translation:}}| ]]
-<span style="font-size: 150%">{{{heading|Documentation}}}</span></div>}}
+</noinclude><includeonly>{{#if:{{{content|}}}|
-<div id="template_doc_page_transcluded" class="dablink plainlinks">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{SUBJECTPAGENAME}}/doc}}}]]. <small style="font-style: normal">([[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history])</small> {{#ifexist: {{#rel2abs: /sandbox }} | {{#ifexist: {{#rel2abs: /testcases}} | <br> This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} edit])</small> and [[/testcases|testcases]] for editors to experiment.}}<!-- else don't show when just 1 of /sandbox or /testcases exists -->}} </div>
+[[Category:Template documentation pages{{#translation:}}]]
-{{ {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{1|{{SUBJECTPAGENAME}}/doc}}}|ns:0}} }}
+}}</includeonly>
-<div style="clear:both;" /></div></div>