Template:Documentation: Difference between revisions

Latest revision as of 22:23, 22 January 2021

{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}{{#if:Template:Lua <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.</translate>

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>

Rationale

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

@@ Line 1: / Line 1: @@
-<div class="template-documentation"><!--
+<noinclude>
+<languages/>
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
+{{documentation|content=
-These are the literal class definitions in common.css:
+{{Lua|Module:Documentation}}
+<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>
-/* For template documentation */
+<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>
-.template-documentation {
-    clear: both;
-    margin: 1em 0 0 0;
-    border: 1px solid #aaa;
-    background-color: #ecfcf4;
-    padding: 5px;
-}
+<translate>
+==Usage== <!--T:2-->
- -->{{#ifeq:{{{heading|μ}}}|<!--**DEFINED BUT EMPTY**-->
+===Customizing display=== <!--T:3-->
-  |<!--**NOTHING**-->
-  |<div style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex">{{#ifeq:{{{content|μ}}}|μ
-   |<span class="editsection plainlinks" id="doc_editlinks">{{#ifexist: {{{1|{{Documentation/docname}}}}}
-    |<!--**    /doc EXISTS**   -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]]
-    |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create]]
-   }}</span>
-  }} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight: bold; font-size: 125%|font-size: 150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Image:Template-info.svg|50px]] Template documentation|Documentation}}}}</span></div>
- }}<!--
- --><div id="template_doc_page_transcluded" class="dablink plainlinks"><!--
+<!--T:4-->
-  -->{{#ifexist: {{{1|{{Documentation/docname}}}}}
+Overrides exist to customize the output in special cases:
-  |<!--**/doc EXISTS**-->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
+</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: {{SUBPAGENAME}}
+<translate>
-   |sandbox|testcases=<!--**DO NOT SHOW THESE LINKS ON THE SANDBOX/TESTCASES PAGES**-->
+==Rationale== <!--T:6-->
-   |#default=
+</translate>
-    {{#switch: {{SUBJECTSPACE}}
+<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>
-     |{{ns:template}}
+<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>
-     |{{ns:user}}=
-      {{#ifexist: {{FULLPAGENAME}}/sandbox
+<translate>
-       |This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> <!--
+==See also== <!--T:9-->
-        -->{{#ifexist: {{FULLPAGENAME}}/testcases
+</translate>
-         |and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment.
+* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
-       |{{#ifexist: {{FULLPAGENAME}}/testcases
+* {{tim|Documentation}}
-        |This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small> for editors to experiment.}}
+* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
- }}}}}}
- </div>
+}}
-{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}}
+[[Category:Formatting templates{{#translation:}}|Template documentation]]
-</div>
+[[Category:Template documentation{{#translation:}}| ]]
+</noinclude><includeonly>{{#if:{{{content|}}}|
+[[Category:Template documentation pages{{#translation:}}]]
+}}</includeonly>