Difference between revisions of "Template:Documentation"

From Confrontation.wiki
Jump to navigation Jump to search
meta>Verdy p
m (if a docname is fed, don't track in "Templates without documentation" (many derived templates, e.g. translations, share the same doc page as a base template, often with parameters for a few variable parts))
m (2 revisions imported)
 
(97 intermediate revisions by 34 users not shown)
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 name=1>Special:MyLanguage/Help:Transclusion</tvar>|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 name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>
| {{#ifeq: {{{4|}}} | {{{4|+}}} | 4 | <!-- dummy -->}} = {{{4|}}}
 
| {{#ifeq: {{{5|}}} | {{{5|+}}} | 5 | <!-- dummy -->}} = {{{5|}}}
<translate>
}}<includeonly>{{#if: {{{1|}}} || {{#ifexist: {{FULLPAGENAME}}/doc || [[Category:Templates without documentation]] }} }}</includeonly><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>

Latest revision as of 08:28, 19 July 2021


Template documentation

Template:Lua 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

Customizing display

Overrides exist to customize 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, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.
Retrieved from "https://confrontation.wiki/index.php?title=Template:Documentation&oldid=2272"