Template:Heavily used module/doc: Difference between revisions

Latest revision as of 17:30, 15 August 2025

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

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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

Because it seems not useful to mark sandboxes or documentations as "heavily used",
the template does not mark these subpages when it recognizes them.

The template automatically sets the following categories: Heavily used modules

Usage

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

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

Typically, this should be reserved for those with 200,000 or more links.

Template parameters

Parameter	Description	Default	Status
`1`	name of another module if its talk page should be used	module's talk page	optional
`b`	The prefix for a {{*PAGENAME}} magic word.	empty	optional
`m`		empty	optional

Template data

Parameter text is empty

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 modules that are heavily used and should only be edited if needed.

Template parameters
This template prefers inline formatting of parameters.
	Description	Type	Status
`1`	name of another module if its talk page should be used Default module's talk page	Page name	optional
`b`	The prefix for a {{*PAGENAME}} magic word. Suggested values `FULL` `BASE` `ROOT` `SUB` `SUBJECT` `TALK`	String	optional
`m`		Number	optional

Additional information

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

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

Localization

English ∙ русский

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

To add your language to the list of languages supported by this template, please copy the code of Template:Heavily used module/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.

@@ Line 15: / Line 15: @@
 | setscats  = {{C|Heavily used modules}}
-| usage-notes = This template is intended to be placed in a section at the top of the documentation of highly used modules ("<nowiki>{{heavily used module}}</nowiki>").<br>Normally, this should be reserved for those with <!-- [[Special:MostLinkedModules|200,000+ links]] -->200,000+.
+| usage-notes = {{mbox|style=width:auto; margin:0 10%;|type=delete|image=|text=This template is intended to be placed inside an '''{{tag|includeonly|o}} section ''' {{color|#bf3c2c|'''at the top of the documentation subpage'''}} of highly used modules:
+<div style="margin-left:1em; margin-top:4px; margin-bottom:4px;"><code><nowiki><includeonly>{{Heavily used module}}</includeonly></nowiki></code></div>
+Typically, this should be reserved for those with [[Special:MostLinkedModules|200,000 or more links]]<!-- , or very essential templates -->.}}
 | seealso =
@@ Line 43: / Line 45: @@
 | 3stat = optional-
 }}
-<includeonly>{{Sandbox other|
+<includeonly>{{Sandbox other||
 <!-- Categories below this line; interwikis at Wikidata -->
-[[Category:Module namespace templates|{{PAGENAME}}]]
+[[Category:Module namespace templates]]
-[[Category:Internationalised marker templates|{{PAGENAME}}]]
+[[Category:Internationalised marker templates]]
+[[Category:Template namespace templates]]
+[[Category:Template header templates]]
 }}</includeonly>