consistent with new substitution template format |
Created page with "<!--------- Box 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. ---------> <div id="Documentation" style="width:99%; clear:both; border:2px solid #000; margin-top:2em;"> <!----------- Header -----------> {| style="width:100%; border-collapse:collapse; background:#DDD; color:#000; border-bottom:1px solid #000;" | style="width:140px; tex..." |
||
| Line 1: | Line 1: | ||
{{ | <!--------- | ||
<!-- | Box | ||
</ | 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. | ||
---------> | |||
<div id="Documentation" style="width:99%; clear:both; border:2px solid #000; margin-top:2em;"> | |||
<!----------- | |||
Header | |||
-----------> | |||
{| style="width:100%; border-collapse:collapse; background:#DDD; color:#000; border-bottom:1px solid #000;" | |||
| style="width:140px; text-align:center; padding:1em;" | [[File:Template-info.svg|100px|link={{FULLPAGENAME}}/doc]] | |||
| 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] • [[Special:WhatLinksHere/{{FULLPAGENAME}}|what links here]] • [{{fullurl:Special:WhatLinksHere/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} what transclude this] • [[Special:PrefixIndex/{{FULLPAGENAME}}/|subpages]]</span> | |||
|} | |||
<!------------------------------ | |||
View Documentation | |||
------------------------------> | |||
<div style="padding:10px 5px;"> | |||
{{#ifexist: {{FULLPAGENAME}}/doc | |||
| {{#if: {{{NOTOC|}}} | __NOTOC__ | {{Tocright}} }} | |||
{{{{PAGENAME}}/doc}} | |||
| <div style="margin:auto;"><strong class="error">This template currently doesn't have any documentation!</strong> | |||
<br /> | |||
Help out by [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit&preload=Template:Documentation/preload}} writing some].</div> | |||
<includeonly>[[Category:Templates Without Documentation]]</includeonly> | |||
}} | |||
</div> | |||
<!------------ | |||
Footer | |||
------------> | |||
<div style="clear:both; background:#DDD; color:#000; border-top:1px solid #000; padding:1em; font-size:12px;"> | |||
Visit {{#ifexist: {{FULLPAGENAME}}/doc | |||
| [[{{FULLPAGENAME}}/doc]] | |||
| [{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Template:Documentazione/preload}} {{FULLPAGENAME}}/doc] | |||
}} to edit this text! ([[Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[w:Help:Purge|why?]]) | |||
</div> | |||
</div> | |||
{{DEFAULTSORT:{{PAGENAME}}|noreplace}} | |||
Revision as of 11:29, 23 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: |
| 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).
See also
Visit Template:Documentation/doc to edit this text! (How does this work?) (Refresh this text - why?)