Template:Documentation: Difference between revisions

Help

VisualWikitext

Latest revision as of 20:50, 28 February 2023

File:Template-info.svg

Template Documentation ^{(sometimes hidden or invisible)}

Template tools: purge • what links here • what transclude this • subpages

Lua logo

Uses Lua:

Module:Documentation

File:OOjs UI icon notice-warning.svg

This template is used in system messages.
Changes to it can cause immediate changes to the MediaWiki user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space.The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

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

@@ Line 1: / Line 1: @@
-<noinclude>
+<!---------
-<languages/>
+     Box
-</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
+Note: the reason why a table is not used for the whole box is because sometimes the templates used as examples in the documentation page will enter in conflict with it.
-{{documentation|content=
+  --------->
+<div id="Documentation" style="width:99%; clear:both; border:2px solid #000; margin-top:2em;">
-{{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>
+     Header
-<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>
+  ----------->
+{| style="width:100%; border-collapse:collapse; background:#DDD; color:#000; border-bottom:1px solid #000;"
-<translate>
+| style="width:140px; text-align:center; padding:1em;" | [[File:Template-info.svg|100px|link={{FULLPAGENAME}}/doc]]
-==Usage== <!--T:2-->
+| style="padding:1em;" | <span style="font-size:20px;">'''Template Documentation'''</span> <sup style="font-size:12px; font-style:italic;">(sometimes hidden or invisible)</sup>
+<span style="font-size:12px;">'''Template tools:''' [{{fullurl:{{FULLPAGENAME}}|action=purge}} purge] &bull; [[Special:WhatLinksHere/{{FULLPAGENAME}}|what links here]] &bull; [{{fullurl:Special:WhatLinksHere/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} what transclude this] &bull; [[Special:PrefixIndex/{{FULLPAGENAME}}/|subpages]]</span>
-===Customizing display=== <!--T:3-->
+|}
+<!------------------------------
-<!--T:4-->
+        View Documentation
-Overrides exist to customize the output in special cases:
+  ------------------------------>
-</translate>
+  <div style="padding:10px 5px;">
-* <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>
+{{#ifexist: {{FULLPAGENAME}}/doc
+    | {{#if: {{{NOTOC|}}} | __NOTOC__ | {{Tocright}} }}
-<translate>
+{{{{PAGENAME}}/doc}}
-==Rationale== <!--T:6-->
+    | <div style="margin:auto;"><strong class="error">This template currently doesn't have any documentation!</strong>
-</translate>
+<br />
-<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 and categories.</translate>
+Help out by  [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit&preload=Template:Documentation/preload}} writing some].</div>
-<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>
+<includeonly>[[Category:Templates Without Documentation]]</includeonly>
+  }}
-<translate>
+  </div>
-==See also== <!--T:9-->
+<!------------
-</translate>
+     Footer
-* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
+  ------------>
-* {{tim|Documentation}}
+  <div style="clear:both; background:#DDD; color:#000; border-top:1px solid #000; padding:1em; font-size:12px;">
-* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
+Visit {{#ifexist: {{FULLPAGENAME}}/doc
+         | [[{{FULLPAGENAME}}/doc]]
-}}
+         | [{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Template:Documentazione/preload}} {{FULLPAGENAME}}/doc]
-[[Category:Formatting templates{{#translation:}}|Template documentation]]
+       }} to edit this text! ([[Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[w:Help:Purge|why?]])
-[[Category:Template documentation{{#translation:}}| ]]
+  </div>
-</noinclude><includeonly>{{#if:{{{content|}}}|
+</div>
-[[Category:Template documentation pages{{#translation:}}]]
+{{DEFAULTSORT:{{PAGENAME}}|noreplace}}
-}}</includeonly>