It is meant to be put at the top of the documentation subpage for templates transcluded onto more than 2,000 pages. For templates transcluded onto more than 100,000 pages, or if the first parameter is set torisk, a stronger wording is given. SeeWikipedia:High-risk templates for background information.
Note: It is normal for some of the links in the message box to be red.
The template can be used as is, and will automatically use bot-updated transclusion counts fromsubpages of Module:Transclusion_count/data/, when available. It can also take some parameters:
1=number of transclusions:(deprecated) The first parameter is either a static number of times the template has been transcluded, or the word "risk" (without quotes) to display "a very large number of" instead of the actual value. This value will be ignored, if transclusion data is available for the current page (generally, for templates with more than 2,000 transclusions).
2=discussion page, or use + notation: The second parameter is overloaded. It will cause the number of transclusions to display as "#,###+" instead of "approximately #,###" when set equal to "yes" (without quotes). When used in this manner, values will be rounded down, instead of rounded to the nearest number with the appropriate number of significant figures. When set to any other non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example,2=WP:VPT will insert a link toWP:VPT),
|info=<extra information>: When set to non-blank, will insert <extra information> into the template text.
|demo=<Template_name>: Will use the transclusion count for the template at[[Template:<Template_name>]] instead of detecting what template it is being used on. Capitalization must exactly match the value used inSpecial:PrefixIndex/Module:Transclusion_count/data/.
|form=: When set to "editnotice", will display the message using{{editnotice}} instead of{{ombox}}.
|no-percent=yes: suppresses automatic 'percent of all pages' annotation; 'percent of all pages' annotation is automatically added when template is used in more than 1% of all pages (currently{{NUMBEROFPAGES}} is 64,340,031 pages so 1% is 643,400 pages)
Examples
The full code for a /doc page top usually looks like this:
{{documentation subpage}}<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->{{high-use}}
{{high-use |49,500+ |demo=A template that does not exist }}
This template is used on49,000+ pages and changes may be widely noticed. Test changes in the template's/sandbox or/testcases subpages, or in your ownuser subpage. Consider discussing changes on thetalk page before implementing them.
This template is used onapproximately 9,770,000 pages. To avoid major disruption and server load, any changes should be tested in the template's/sandbox or/testcases subpages, or in your ownuser subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them.
{{high-use |risk |demo=High-use }}
This template is used onapproximately 13,000 pages. To avoid major disruption, any changes should be tested in the template's/sandbox or/testcases subpages, or in your ownuser subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them.
{{high-use |risk |Wikipedia talk:High-risk templates |info=This is a very large number! |demo=Yesno}}
The/sandbox and/testcases links are the standard names for such subpages. If those pages are created, then the green /doc box for the template will detect them and link to them in its heading. For instance, see the top of this documentation.
Special:PrefixIndex/Module:Transclusion_count/data/ – template count data used by this template that is broken down by first letter of template and rounded to two or three significant figures, and updated weekly
This is the {{high-use}} message box.It is meant to be put at the top of the documentation subpage for templates transcluded onto more than 2,000 pages. For templates transcluded onto more than 100,000 pages, or if the first parameter is set to risk, then a stronger wording is given.Note: It is normal that some of the links in the message box are red.
This template prefers inline formatting of parameters.
Parameter
Description
Type
Status
number of transclusions (DEPRECATED)
1
either a static number of times the template has been transcluded, or the word "risk" (without quotes) to display "a very large number of" instead of the actual value.
Suggested values
risk
String
deprecated
discussion page, or use + notation
2
The second parameter is overloaded. It will cause the number of transclusions to display as "#,###+" instead of "approximately #,###" when set equal to "yes" (without quotes). When used in this manner, values will be rounded down, instead of rounded to the nearest number with the appropriate number of significant figures. When set to any other non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, 2=WP:VPT will insert a link to WP:VPT)
Default
Auto value
String
optional
Extra information
info
When set to non-blank, will insert the value of this parameter into the template text.
Content
optional
template name (intended for demo purposes)
demo
Will use the transclusion count for the template at [[Template:<Template_name>]] instead of detecting what template it is being used on. Capitalization must exactly match the value used in Special:PrefixIndex/Module:Transclusion_count/data/.
String
optional
form for this template
form
When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.
Suggested values
editnotice
String
optional
Expiry for {{editnotice}}
expiry
if `form=editnotice`, this will set the expiry parameter of the editnotice.
