Difference between revisions of "Template:Documentation"

From BTAWiki
Jump to navigation Jump to search
(Refactoring to reduce transclusion depth. Basically, split core2 into (start box2,end box2) and split core into (start box,end box), then move middle up two levels to top level template. See talk...)
m (2 revisions imported)
 
(148 intermediate revisions by 66 users not shown)
Line 1: Line 1:
−
<!--
+
<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;"></div>{{template sandbox notice}}
+
{{documentation|content=
−
}}<!--
 
−
  Automatically add {{pp-template}} to protected templates.
 
−
-->{{template other
 
−
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
 
−
  | {{pp-template|docusage=yes}}
 
−
  | {{#if: {{PROTECTIONLEVEL:edit}}
 
−
    | {{pp-template|docusage=yes}}
 
−
    | <!--Not protected, or only semi-move-protected-->
 
−
    }}
 
−
  }}
 
−
}}<!--
 
−
  Start of green doc box.
 
−
-->{{documentation/start box2
 
−
| preload = {{{preload|}}}  <!--Allow custom preloads-->
 
−
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
 
−
| heading-style = {{{heading-style|}}}
 
−
| content = {{{content|}}}
 
  
−
<!--Some namespaces must have the /doc, /sandbox and /testcases
+
{{Lua|Module:Documentation}}
−
    in talk space-->
+
<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>
−
| docspace = {{documentation/docspace}}
+
<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>
  
−
| 1 = {{{1|}}}  <!--Other docname, if fed-->
+
<translate>
 +
==Usage== <!--T:2-->
  
−
<!--The namespace is added in /start box2-->
+
===Customizing display=== <!--T:3-->
−
| template page = {{documentation/template page}}
 
  
−
}}<!-- Start content --><!--
+
<!--T:4-->
−
  Start load the /doc content:
+
Overrides exist to customize the output in special cases:
−
  Note: The line breaks between this comment and the next line are necessary
+
</translate>
−
  so  "=== Headings ===" at the start and end of docs are interpreted.
+
* <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>
−
-->
 
−
{{#if: {{{content|}}}
 
−
| {{{content|}}}
 
−
| {{#if: {{#ifexist:
 
−
    {{#if: {{{1|}}}
 
−
    | {{{1|}}}  <!--Other docname fed-->
 
−
    | {{documentation/docspace}}:{{documentation/template page}}/doc
 
−
    }}
 
−
  | yes
 
−
  }}
 
−
  | {{ {{#if: {{{1|}}}
 
−
  | {{{1|}}}
 
−
  | {{documentation/docspace}}:{{documentation/template page}}/doc
 
−
  }} }}
 
−
  }}
 
−
}}
 
−
<!--
 
−
  End load the /doc content:
 
−
  Note: The line breaks between this comment and the previous line are necessary
 
−
  so  "=== Headings ===" at the start and end of docs are interpreted.
 
−
-->{{documentation/end box2
 
−
| content = {{{content|}}}
 
−
| link box = {{{link box|}}}  <!--So "link box=off" works-->
 
  
−
<!--Some namespaces must have the /doc, /sandbox and /testcases
+
<translate>
−
    in talk space-->
+
==Rationale== <!--T:6-->
−
| docspace = {{documentation/docspace}}
+
</translate>
 +
<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>
 +
<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>
  
−
| 1 = {{{1|}}}  <!--Other docname, if fed-->
+
<translate>
 +
==See also== <!--T:9-->
 +
</translate>
 +
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
 +
* {{tim|Documentation}}
 +
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
  
−
<!--The namespace is added in /end box2-->
+
}}
−
| template page = {{documentation/template page}}
+
[[Category:Formatting templates{{#translation:}}|Template documentation]]
−
 
+
[[Category:Template documentation{{#translation:}}| ]]
−
}}<!--
+
</noinclude><includeonly>{{#if:{{{content|}}}|
−
  End of green doc box
+
[[Category:Template documentation pages{{#translation:}}]]
−
--><noinclude>
+
}}</includeonly>
−
 
 
−
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
−
</noinclude>
 

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:}}| ]]

Retrieved from "https://www.bta3062.com/index.php?title=Template:Documentation&oldid=4730"