Difference between revisions of "Template:Documentation"

From BTAWiki
Jump to navigation Jump to search
meta>Verdy p
m (some doc pages need a few parameters (e.g. for feeding categories in their includeonly section, or for the actual template name to document))
m (2 revisions imported)
 
(96 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|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>
| {{#if: {{{2|}}} | 2 | <!--dummy--> }} = {{{2|}}} <!--Other parameters for doc page, if fed-->
+
<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>
| {{#if: {{{3|}}} | 3 | <!--dummy--> }} = {{{3|}}} <!--Other parameters for doc page, if fed-->
+
<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>
| {{#if: {{{4|}}} | 4 | <!--dummy--> }} = {{{4|}}} <!--Other parameters for doc page, if fed-->
+
 
}}<noinclude>
+
<translate>
<!-- Add categories and interwikis to the /doc subpage, not here! ??? -->
+
==See also== <!--T:9-->
</noinclude>
+
</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>

Latest revision as of 23:22, 16 November 2020

<languages/>

Script error: No such module "documentation".[[Category:Template documentation pages{{#translation:}}]] [[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]