Template:Documentation: Difference between revisions

From Laserwiki
Jump to navigation Jump to search
No edit summary
m (360 revisions imported)
 
(95 intermediate revisions by 34 users not shown)
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|{{{livepage|}}}}}
 
}}<!--
{{Lua|Module:Documentation}}
  Start of green doc box.
<translate>
-->{{Documentation/start box2
<!--T:12-->
| preload = {{{preload|}}}<!-- Allow custom preloads -->
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>
| heading = {{{heading|¬}}}<!-- Empty but defined means no header -->
<translate>
| heading-style = {{{heading-style|}}}
<!--T:13-->
| content = {{{content|}}}
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.
| docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
 
| 1 = {{{1|}}}<!-- Other docname, if fed -->
==Usage== <!--T:2-->
| lang = {{{lang|}}}
 
| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 -->
===Customizing display=== <!--T:3-->
}}<!--
 
  Start load the /doc content:
<!--T:4-->
  Note: The line break between this comment and the next line is necessary
Overrides exist to customize the output in special cases:
  so an  "=== Heading ===" at start of doc subpage is correctly interpreted.
</translate>
-->
* <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>
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}}
 
| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude -->
<translate>
| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }}
==Rationale== <!--T:6-->
| 0110 | 0111 = {{ {{{1|}}} }}
 
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}}
<!--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>
  End load the /doc content:
<translate>
  Note: The line break between this comment and the next line is necessary
<!--T:8-->
  so an "=== Heading ===" at end of doc subpage is correctly interpreted.
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]]).
-->
 
{{Documentation/end box2
==See also== <!--T:9-->
| preload = {{{preload|}}}<!-- Allow custom preloads -->
</translate>
| content = {{{content|}}}
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
| link box = {{{link box|}}}<!-- So "link box=off" works -->
* {{tim|Documentation}}
| docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
| 1 = {{{1|}}}<!-- Other docname, if fed -->
 
| lang = {{{lang|}}}
}}
| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 -->
[[Category:Formatting templates{{#translation:}}|Template documentation]]
}}<!--
[[Category:Template documentation{{#translation:}}| ]]
  End of green doc box
</noinclude><includeonly>{{#if:{{{content|}}}|
--></includeonly><noinclude>
[[Category:Template documentation pages{{#translation:}}]]
{{Documentation}}
}}</includeonly>
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

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"