Template:Documentation: Difference between revisions

From Laserwiki
Jump to navigation Jump to search
meta>Verdy p
mNo edit summary
m (360 revisions imported)
 
(93 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>
  | sandbox
<!--T:12-->
  | testcases = {{BASEPAGENAME}}
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>
  | #default = {{PAGENAME}}
<translate>
  }}
<!--T:13-->
| docspace =
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.
  <!--Some namespaces must have the /doc, /sandbox and /testcases in talk space-->
 
  {{#switch: {{SUBJECTSPACE}}
==Usage== <!--T:2-->
  | {{ns:0}}
 
  | {{ns:File}}
===Customizing display=== <!--T:3-->
  | {{ns:MediaWiki}}
 
  | {{ns:Category}} = {{TALKSPACE}}
<!--T:4-->
  | #default = {{SUBJECTSPACE}}
Overrides exist to customize the output in special cases:
  }}
</translate>
| content = {{{content|}}}
* <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>
| 1 = {{{1|}}} <!--Other docname, if fed-->
 
| {{{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>
| {{{ifeq: {{{3|}}} | {{{3|+}}} | 3 | <!-- dummy -->}} = {{{3|}}}
==Rationale== <!--T:6-->
| {{{ifeq: {{{4|}}} | {{{4|+}}} | 4 | <!-- dummy -->}} = {{{4|}}}
 
| {{{ifeq: {{{5|}}} | {{{5|+}}} | 5 | <!-- dummy -->}} = {{{5|}}}
<!--T:7-->
}}<noinclude>
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>
<!-- Add categories and interwikis to the /doc subpage, not here! ??? -->
<translate>
</noinclude>
<!--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]]).
 
==See also== <!--T:9-->
</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 18:24, 17 September 2020

<languages/>

Template documentation

<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.

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>

<translate>

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.</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]]).

See also

</translate>

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

[[Category:Template documentation pages{{#translation:}}]]

[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]

Retrieved from "https://bitcrush.io/laserwiki/index.php?title=Template:Documentation&oldid=4957"