Template:Documentation: Difference between revisions

Latest revision as of 18:24, 17 September 2020

Template documentation

Uses Lua:

Module: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>

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

@@ Line 1: / Line 1: @@
-<!--Automatically add {{pp-template}} to protected templates.
+<noinclude>
--->{{template other
+<languages/>
-| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
-  | {{pp-template}}
+{{documentation|content=
-  | {{#if: {{PROTECTIONLEVEL:edit}}
-    | {{pp-template}}
-    | <!--Not protected, or only semi-move-protected-->
-    }}
-  }}
-}}<!--
-  Start of green doc box.
---><div class="template-documentation"><!--
-These are the literal class definitions in MediaWiki: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>
+<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.
-/* For template documentation */
+==Usage== <!--T:2-->
-.template-documentation {
-    clear: both;
-    margin: 1em 0 0 0;
-    border: 1px solid #aaa;
-    background-color: #ecfcf4;
-    padding: 1em;
-}
- -->{{#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]] [{{purge|purge}}]
-    |<!--**/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>
- }}{{Documentation/links}}<!-- Add links to /sandbox and /testcases when appropriate -->
+* <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>
- </div>
-{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}}
-<div style="clear: both;"></div>
-</div><!--End of green doc box--><noinclude>
-<!-- Add categories and interwikis to the /doc subpage, not here! -->
+<translate>
-</noinclude>
+==Rationale== <!--T:6-->
+<!--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]]).
+==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>

Template:Documentation: Difference between revisions

Latest revision as of 18:24, 17 September 2020

Contents

Usage

Customizing display

Rationale

See also

Navigation menu