Difference between revisions of "Template:Documentation"

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

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"