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: @@
-{{documentation/core2
+<noinclude>
-| heading = {{{heading|¬}}}<!--defined and empty means no header-->
+<languages/>
-| heading-style = {{{heading-style|}}}
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
-| link box = {{{link box|}}} <!--So "link box=off" works-->
+{{documentation|content=
-| template page =
-  <!--The namespace is added in /core2-->
+{{Lua|Module:Documentation}}
-  {{#switch: {{SUBPAGENAME}}
+<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>
-  | sandbox
+<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>
-  | testcases = {{BASEPAGENAME}}
-  | #default = {{PAGENAME}}
+<translate>
-  }}
+==Usage== <!--T:2-->
-| docspace =
-  <!--Some namespaces must have the /doc, /sandbox and /testcases in talk space-->
+===Customizing display=== <!--T:3-->
-  {{#switch: {{SUBJECTSPACE}}
-  | {{ns:0}}
+<!--T:4-->
-  | {{ns:File}}
+Overrides exist to customize the output in special cases:
-  | {{ns:MediaWiki}}
+</translate>
-  | {{ns:Category}} = {{TALKSPACE}}
+* <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>
-  | #default = {{SUBJECTSPACE}}
-  }}
+<translate>
-| content = {{{content|}}}
+==Rationale== <!--T:6-->
-| 1 = {{{1|}}} <!--Other docname, if fed-->
+</translate>
-| {{{ifeq: {{{2|}}} | {{{2|+}}} | 2 | <!-- dummy -->}} = {{{2|}}}<!--some doc pages may have a few optional parameters to change their text, or set template categories in their noinclude section-->
+<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>
-| {{{ifeq: {{{3|}}} | {{{3|+}}} | 3 | <!-- dummy -->}} = {{{3|}}}
+<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>
-| {{{ifeq: {{{4|}}} | {{{4|+}}} | 4 | <!-- dummy -->}} = {{{4|}}}
-| {{{ifeq: {{{5|}}} | {{{5|+}}} | 5 | <!-- dummy -->}} = {{{5|}}}
+<translate>
-}}<noinclude>
+==See also== <!--T:9-->
-<!-- Add categories and interwikis to the /doc subpage, not here! ??? -->
+</translate>
-</noinclude>
+* <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>