Template:Documentation

{{#ifeq: BarkWiki|Templates Wiki||

Your wiki got a version of Template:Documentation that is only relevant to Templates Wiki! Click here to revert it. For a documentation template you can use on your wiki, see Template:Documentation (copy) on Templates Wiki.

}}

Template information, documentation, and installation instructions.
Expand the below text for usage and other information.

{{#if: ||

Template Documentation:

Note: The template above might be broken without the parameters; while not ideal and often not necessary, this is common.
{{#if: 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.

content = should the template have just a short blurb for documentation and not need a new page for it.
installonly = for documentation templates
If the template should transclude a documentation page other than its /doc subpage, use {{Documentation|documentation page}}.
You may also use {{Documentation|content=documentation goes here}} to include documentation without a subpage at all.
If the template should be interlanguage linked but at a different name, use {{Documentation|fr=French name|ja=Japanese name|tr=Turkish name|zh=Chinese name}}.
You might instead create a redirect on the foreign-language wiki from the name used on this wiki to theirs.
SPW
- SPW=is not relevant - The template (such as this one) are not relevant to wikis other than Templates Wiki.
- SPW=starter - The wikis after created on March 11, 2020 by default.
dep1=dep2=dep3=dep4= to name up to four dependency templates (include Template: prefix, no need to name /doc pages).
Supports the following interlanguage links:
- de = German equivalent template name
- es = Spanish equivalent template name
- fr = French equivalent template name
- it = Italian equivalent template name
- ja = Japanese equivalent template name
- ko = Korean equivalent template name
- nl = Dutch/Flemish equivalent template name
- pt = Portuguese equivalent template name
- tr = Turkish equivalent template name
- zh = Simplified Chinese equivalent template name

  | Edit this template for the documentation| {{#ifexist: Template:Documentation/doc
    | View, edit, or check the history of this documentation.
    |Create documentation for this template.
    }}
   }} (How does this work?)
Editors can experiment with this template's sandbox and testcases.

{{#if: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.

content = should the template have just a short blurb for documentation and not need a new page for it.
installonly = for documentation templates
If the template should transclude a documentation page other than its /doc subpage, use {{Documentation|documentation page}}.
You may also use {{Documentation|content=documentation goes here}} to include documentation without a subpage at all.
If the template should be interlanguage linked but at a different name, use {{Documentation|fr=French name|ja=Japanese name|tr=Turkish name|zh=Chinese name}}.
You might instead create a redirect on the foreign-language wiki from the name used on this wiki to theirs.
SPW
- SPW=is not relevant - The template (such as this one) are not relevant to wikis other than Templates Wiki.
- SPW=starter - The wikis after created on March 11, 2020 by default.
dep1=dep2=dep3=dep4= to name up to four dependency templates (include Template: prefix, no need to name /doc pages).
Supports the following interlanguage links:
- de = German equivalent template name
- es = Spanish equivalent template name
- fr = French equivalent template name
- it = Italian equivalent template name
- ja = Japanese equivalent template name
- ko = Korean equivalent template name
- nl = Dutch/Flemish equivalent template name
- pt = Portuguese equivalent template name
- tr = Turkish equivalent template name
- zh = Simplified Chinese equivalent template name

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

content = should the template have just a short blurb for documentation and not need a new page for it.
installonly = for documentation templates
If the template should transclude a documentation page other than its /doc subpage, use {{Documentation|documentation page}}.
You may also use {{Documentation|content=documentation goes here}} to include documentation without a subpage at all.
If the template should be interlanguage linked but at a different name, use {{Documentation|fr=French name|ja=Japanese name|tr=Turkish name|zh=Chinese name}}.
You might instead create a redirect on the foreign-language wiki from the name used on this wiki to theirs.
SPW
- SPW=is not relevant - The template (such as this one) are not relevant to wikis other than Templates Wiki.
- SPW=starter - The wikis after created on March 11, 2020 by default.
dep1=dep2=dep3=dep4= to name up to four dependency templates (include Template: prefix, no need to name /doc pages).
Supports the following interlanguage links:
- de = German equivalent template name
- es = Spanish equivalent template name
- fr = French equivalent template name
- it = Italian equivalent template name
- ja = Japanese equivalent template name
- ko = Korean equivalent template name
- nl = Dutch/Flemish equivalent template name
- pt = Portuguese equivalent template name
- tr = Turkish equivalent template name
- zh = Simplified Chinese equivalent template name

 | {{#ifexist: Template:Documentation/doc
   | {{#if: 
     |{{{{{1}}}}}
     |Template:Documentation/doc}}

   | Documentation does not exist. Create it at [{{fullurl:
             {{#if:|{{{1}}}|Template:Documentation/doc}}
             |action=edit&preload=Template:Documentation/preload&summary=Create+documentation+for+%5B%5BTemplate%3ADocumentation%5D%5D {{#if:|{{{1}}}|Template:Documentation/doc}}] .
 }}

}} }}

}}

Installation Instructions

{{#ifexist: Template:Documentation/install

    |: View installation Instructions.}}

{{#ifeq:is not relevant|is not relevant

   |
   | :Export this template, then import to install it.
Use edit summary: Copied from [[w:c:templates:Template:Documentation]] to properly attribute this template's editors.}}{{#if:|:This template is compatible with vanilla MediaWiki.}}

{{#switch: is not relevant

   | starter = This template is created by default after March 11, 2020. It should be in your wiki.

| is not relevant

| is not relevant to =

File:Warning.svg

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:Documentation (copy)|For a similar template intended to be copied, see Template:Documentation (copy).}}{{#ifeq: BarkWiki

       | Templates Wiki
       | 
     }}
  }}

{{#if:

   |[[de:{{{de}}}]]
   |
  }}{{#if:
   |[[es:{{{es}}}]]
   |
  }}{{#if:Modèle:Documentation
   |fr:Modèle:Documentation
   |
  }}{{#if:
   |[[it:{{{it}}}]]
   |
  }}{{#if:Template:Documentation
   |ja:Template:Documentation
   |
  }}{{#if:
   |[[ko:{{{ko}}}]]
   |
  }}{{#if:
   |[[nl:{{{nl}}}]]
   |
  }}{{#if:
   |[[pt:{{{pt}}}]]
   |
  }}{{#if:Şablon:Belgelendirme
   |tr:Şablon:Belgelendirme
   |
  }}{{#if:Template:Documentation
   |zh:Template:Documentation
   |
   }}

{{#ifeq: is not relevant|is not relevant | |{{#if:

 | The above message will be enough for most cases; if there are additional instructions, you can see them below.
 Template:Documentation/install
 | :There is no additional installation instructions for this template. If there is any, you may create it at Template:Documentation/install.

}} }}