imported>Shovon: Created page with "{{#ifeq: {{SITENAME}}|Templates Wiki||
'''Your wiki got a version of Template:Documentation that is only relevant to Templates Wiki!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.] For a documentation template you can use on yo..."

2025-10-14T21:21:35Z

Created page with "<onlyinclude><includeonly>{{#ifeq: {{SITENAME}}|Templates Wiki||<div style="margin:1em; padding:10px; border: 0.5px solid #c91010; border-radius:10px; background:#f001"><span class="error">'''Your wiki got a version of Template:Documentation that is only relevant to Templates Wiki!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.]</span> For a documentation template you can use on yo..."

New page

<onlyinclude><includeonly>{{#ifeq: {{SITENAME}}|Templates Wiki||<div style="margin:1em; padding:10px; border: 0.5px solid #c91010; border-radius:10px; background:#f001"><span class="error">'''Your wiki got a version of [[Template:Documentation]] that is only relevant to [[w:c:templates|Templates Wiki]]!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.]</span>
For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)|Template:Documentation (copy) on Templates Wiki]].</div>}}<div style="text-align:center;"><span style="font-size:large;">Template information, documentation, and installation instructions.</span><br/>
Expand the below text for usage and other information.</div>
----{{#if: {{{installonly|}}} ||<div style="padding:10px; border:1px solid #444c4d; clear:both; margin-bottom:0; border-bottom:unset; border-radius:10px 10px 0 0;" class="mw-collapsible article-table" data-collapsetext="Hide documentation" data-expandtext="Show documentation">
<span style="font-size:large;">'''Template Documentation'''</span>:<div style="margin:0; padding:1em; border: 0.5px solid #444c4d; border-radius:10px;" class="mw-collapsible-content">''Note: The template above might be broken without the parameters; this is normal.''<br/>{{#if: {{{content|}}}
| [{{fullurl: {{FULLPAGENAME}}|action=edit}} Edit this template] for the documentation| {{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
| View, edit, or check the history of [[:{{{1|{{FULLPAGENAME}}/doc}}}|this documentation]].
|[{{fullurl: {{{1|{{FULLPAGENAME}}/doc}}}
|action=edit&preload=Template:Documentation/preload&summary={{urlencode:Create documentation for [[{{FULLPAGENAME}}]]}}
}} Create documentation] for this template.
}}
}} ([[Template:Documentation/doc|How does this work?]])<br/>Editors can experiment with this template's [{{fullurl:{{{sandbox|{{FULLPAGENAME}}/sandbox}}}
| action=edit&redlink=1&preload=Template:Documentation/preload-sandbox&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}
}} sandbox] and [{{fullurl:{{{testcases|{{FULLPAGENAME}}/testcases}}}
| action=edit&redlink=1&preload=Template:Documentation/preload-testcases&summary={{urlencode:Create testcases subpage of [[{{FULLPAGENAME}}]]}}
}} testcases].
</div>
<div style="background:none;" class="mw-collapsible-content">
{{Tocright}}
{{#if:{{{content|}}}
| {{{content}}}{{clear}}

| {{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
| {{#if: {{{1|}}}
|{{{{{1}}}}}
|{{{{FULLPAGENAME}}/doc}}}}{{clear}}
| Documentation does not exist. Create it at [{{fullurl:
{{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}
|action=edit&preload=Template:Documentation/preload&summary={{urlencode:Create documentation for [[{{FULLPAGENAME}}]]}} {{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}] [[category:templates without documentation]].
}}
}}

}}
</div></div><div style="display:none;">
----
</div>}}<div style="padding:10px;border:1px solid #444c4d; margin-top:0; border-radius:0 0 10px 10px;" class="mw-collapsible article-table" data-collapsetext="Hide install instructions" data-expandtext="Show install instructions">
<span style="font-size:large;">'''Installation Instructions'''</span><div class="mw-collapsible-content">
<div style="margin:1em; padding:5px; background:#0121; border: 0.5px solid #36475e; border-radius:10px;clear: both;">
{{#ifeq:{{{SPW}}}|is not relevant
|

| :'''''[{{fullurl:Special:Export}}?link1=Template:{{PAGENAMEE}}&link2=Template:{{PAGENAMEE}}/doc{{#if:{{{dep1|}}}|&link3={{{dep1}}}&link4={{{dep1}}}/doc}}{{#if:{{{dep2|}}}|&link5={{{dep2}}}&link6={{{dep2}}}/doc}}{{#if:{{{dep3|}}}|&link7={{{dep3}}}&link8={{{dep3}}}/doc}}{{#if:{{{dep4|}}}|&link9={{{dep4}}}&link10={{{dep4}}}/doc}} Export this template]''', then [[w:Help:Importing and exporting pages|import]] to install it.<br/>''Use edit summary: ''<code><nowiki>Copied from [[w:c:templates:</nowiki>{{FULLPAGENAME}}<nowiki>]]</nowiki></code>'' to properly attribute this template's editors.}}{{#if:{{{vanilla|}}}|:''This template is compatible with vanilla MediaWiki.''}}

:{{#switch: {{{SPW|}}}
| starter = This template is created by default after March 11, 2020. It should be in your wiki. [[Category:Starter templates]]
| is not relevant
| is not relevant to = [[File:Warning.svg|left|50px]]''This template should not be copied, because it is probably not relevant to wikis other than Templates Wiki. '''You probably don't want to copy this template to your wiki.''' {{#if:{{{SPW-link|}}}|For a similar template intended to be copied, see [[Template:{{{SPW-link}}}]].''}}{{#ifeq: {{SITENAME}}
| Templates Wiki
| [[Category:Templates Wiki templates]]
}}
}}
</div>
{{#if:{{{fr|}}}
|[[fr:{{{fr}}}]]
|
}}{{#if:{{{ja|}}}
|[[ja:{{{ja}}}]]
|
}}{{#if:{{{tr|}}}
|[[tr:{{{tr}}}]]
|
}}{{#if:{{{zh|}}}
|[[zh:{{{zh}}}]]
|
}}

{{#ifeq: {{{SPW}}}|is not relevant |
|{{#if: {{PROTECTIONEXPIRY: edit |{{{install|{{FULLPAGENAME}}/install}}}}}
| ''The above message will be enough for most cases; if there are additional instructions, you can see them below.''<br/> {{{{{install|{{FULLPAGENAME}}/install}}}}}
| :There is no additional installation instructions for this template. If there is any, you may create it at [{{fullurl:
{{{install|{{FULLPAGENAME}}/install}}}
|action=edit&preload=Template:Documentation/preload-install}} {{{install|{{FULLPAGENAME}}/install}}}].
}}
}}
</div></div></includeonly></onlyinclude>
{{Documentation|SPW = is not relevant|SPW-link = Documentation (copy)|fr=Modèle:Documentation|ja=Template:Documentation|tr=Şablon:Belgelendirme|zh=Template:Documentation|content= This is a version of Template:Documentation customized for Templates Wiki and so not designed to be copied to other wikis.

It acts identically to the usual Template:Documentation - and should be treated identically - except for a few particular cases.
* <code>content = </code> should the template have just a short blurb for documentation and not need a new page for it.
* <code>installonly =</code> for documentation templates
* If the template '''should transclude a documentation page other than its /doc subpage,''' use <code><nowiki>{{Documentation|documentation page}}</nowiki></code>.
*: You may also use <code><nowiki>{{Documentation|content=documentation goes here}}</nowiki></code> to include documentation without a subpage at all.
* If the template '''should be [[w:Help:Interlanguage links|interlanguage linked]] but at a different name,''' use <code><nowiki>{{Documentation|fr=French name|ja=Japanese name|tr=Turkish name|zh=Chinese name}}</nowiki></code>.
*: You might instead create a [[w:Help:Redirect|redirect]] on the foreign-language wiki from the name used on this wiki to theirs.
* SPW
** <code>SPW=is not relevant</code> - The template (such as this one) are not relevant to wikis other than Templates Wiki.
** <code>SPW=starter</code> - The wikis after created on March 11, 2020 by default.
* <code>dep1=</code><code>dep2=</code><code>dep3=</code><code>dep4=</code> to name up to four dependency templates (include Template: prefix, no need to name /doc pages).
}}[[Category:Documentation templates| ]]

Template:Documentation - Revision history

imported>Shovon: Created page with "{{#ifeq: {{SITENAME}}|Templates Wiki||'''Your wiki got a version of Template:Documentation that is only relevant to Templates Wiki!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.] For a documentation template you can use on yo..."

imported>Shovon: Created page with "{{#ifeq: {{SITENAME}}|Templates Wiki||
'''Your wiki got a version of Template:Documentation that is only relevant to Templates Wiki!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.] For a documentation template you can use on yo..."