Template:Heavily used template/doc

Note: This template is used on a great lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.

Afterwards, changes can initially be done at and tested with Template:Heavily used template/sandbox.

• Editing a template causes all pages that use the template to be re-rendered. If the template is used often, this can put a lot of load on the servers since it fills up the job queue.
• Keep in mind that templates that are used on file description pages also show up on other wikis.

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Heavily used template.

---

This template marks all templates that are heavily used and should only be edited if needed.

The template automatically sets the following categories:

• Heavily used templates (or Very heavily used templates if Parameter 3 is not empty)

Usage

{{Heavily used template}}

Or use the shorthand

{{High-risk|… parameters as described …}}

This template is intended to be placed inside an ‎<includeonly> section at the top of the documentation subpage of highly used templates:

<includeonly>{{Heavily used template}}</includeonly>

Typically, this should be reserved for those with 7 or more transclusions (on at least 1 in 500 pages). See the Special:MostLinkedTemplates.

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

---

Wikipedia's help about TemplateData • Commons-specific information

This template marks all templates that are heavily used and should only be edited if needed.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
talk page	1	The full name of a template talk page, e.g. “Template talk:Xyz”.	Page name	optional
sandbox page	2	The full name of a template sandbox page.	Page name	optional
very heavily	3	any value when it is '''very''' heavily used, e.g. {{Heavily used template|3=✔}}	String	optional
editparm	edit	creates a link for editing, when any value, e.g. {{Heavily used template|edit=✔}}	String	optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: Administrators

See also

• Template:Use sandbox
• Template:Heavily used module

Localization

This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:Heavily used template/layout.

To add your language to the list of languages supported by this template, please copy the code of Template:Heavily used template/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.