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: @@
-<includeonly><!--
+<noinclude>
-  Automatically add {{template sandbox notice}} when on a /sandbox page.
+<languages/>
--->{{#ifeq: {{SUBPAGENAME}} | sandbox |
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
-<div style="clear:both" />
+{{documentation|content=
-{{Template sandbox notice{{translation}}|{{{livepage|}}}}}
-}}<!--
+{{Lua|Module:Documentation}}
-  Start of green doc box.
+<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>
--->{{Documentation/start box2{{translation}}
+<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>
-| preload = {{{preload|}}}<!-- Allow custom preloads -->
-| heading = {{{heading|¬}}}<!-- Empty but defined means no header -->
+<translate>
-| heading-style = {{{heading-style|}}}
+==Usage== <!--T:2-->
-| content = {{{content|}}}
-| docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
+===Customizing display=== <!--T:3-->
-| 1 = {{{1|}}}<!-- Other docname, if fed -->
-| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 -->
+<!--T:4-->
-}}<!--
+Overrides exist to customize the output in special cases:
-  Start load the /doc content:
+</translate>
-  Note: The line break between this comment and the next line is necessary
+* <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>
-  so an  "=== Heading ===" at start of doc subpage is correctly interpreted.
--->
+<translate>
-{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}}
+==Rationale== <!--T:6-->
-| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude -->
+</translate>
-| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }}
+<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>
-| 0110 | 0111 = {{ {{{1|}}} }}
+<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>
-| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}}
-}}<!--
+<translate>
-  End load the /doc content:
+==See also== <!--T:9-->
-  Note: The line break between this comment and the next line is necessary
+</translate>
-  so an "=== Heading ===" at end of doc subpage is correctly interpreted.
+* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
--->
+* {{tim|Documentation}}
-{{Documentation/end box2{{translation}}
+* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
-| preload = {{{preload|}}}<!-- Allow custom preloads -->
-| content = {{{content|}}}
+}}
-| link box = {{{link box|}}}<!-- So "link box=off" works -->
+[[Category:Formatting templates{{#translation:}}|Template documentation]]
-| docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
+[[Category:Template documentation{{#translation:}}| ]]
-| 1 = {{{1|}}}<!-- Other docname, if fed -->
+</noinclude><includeonly>{{#if:{{{content|}}}|
-| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 -->
+[[Category:Template documentation pages{{#translation:}}]]
-}}<!--
+}}</includeonly>
-  End of green doc box
---></includeonly><noinclude>
-{{Documentation}}
-<!-- Add categories and interwikis to the /doc subpage, not here! -->
-</noinclude>