Template:Documentation/sandbox

From PZwiki
Furniture Pickup.png
It has been suggested that this template be moved to Template:Documentation.
Notebook.pngTemplate Documentation

This template is used to contain the documented information and instructions of a certain template.

Usage

To use this template, use the following syntax:

{{Documentation|doc =
template documentation...
}}

Parameters

doc Required
The documentation of the template. Will add the template to "Template without documentation" category if empty.

Example

It is recommended to use the <noinclude> tag to prevent the documentation from appearing when the template is used:

<noinclude>
{{Documentation|doc =
template documentation...
}}
</noinclude><includeonly>template code...</includeonly>

How to translate

This template is translatable.

Template code

Paste the following code into the <includeonly> tag of the translated template and translate the text after each = sign (except for #default =).

{{#switch: {{{1|}}}
| header = Template Documentation
| empty = '''This template doesn't have any documentation yet!''' Help out by <span class="plainlinks">[{{Fullurl:{{FULLPAGENAME}}|action=edit}} writing some]</span>.
| footer = Editors can experiment in this template's [[{{Languages/core}}/sandbox|sandbox]].
| #default = [[Category:Incorrect template usage]]
}}

Template documentation

Copy the code wrapped in the <noinclude> tag in this template and translate the text after doc = in the {{Documentation}} template.

{{Translation guide}} template should be removed from the translated documentation.

See also

Editors can experiment in this template's sandbox.