Template:High-use

From The Kodiak Republic Wiki

(Redirected from Template:Risky template)

Template documentation (for the above template, sometimes hidden or invisible)

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.

Usage

{{High-use}}

{{High-use |2=discussion page, or use + notation|info=additional text}}

all parameters

{{High-use |1= |2= |info= |demo= |form= |expiry= }}

The template can be used as is, and will automatically use bot-updated transclusion counts from subpages 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 to WP: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 in Special:PrefixIndex/Module:Transclusion_count/data/.
  • |form=: When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.
  • |expiry=: Sets the |expiry= parameter for {{editnotice}}.
  • |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 1,989 pages so 1% is 19 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}}

Standard form

{{high-use}}
{{high-use | |Wikipedia talk:High-risk templates }}

Rounding and + notation

{{high-use |49,500 |demo=A template that does not exist }}
{{high-use |49,500+ |demo=A template that does not exist }}

Editnotice form

{{high-use |form=editnotice }}

Lua error: expandTemplate: template "editnotice" does not exist.

High risk

{{high-use |demo=Yesno }}
{{high-use |demo=Yesno |no-percent=yes}}
{{high-use |risk |demo=High-use }}
{{high-use |risk |Wikipedia talk:High-risk templates |info=This is a very large number! |demo=Yesno}}

Technical details

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.

Ahechtbot compiles usage statistics for all templates with 2,000 or more transclusions, using User:Ahechtbot/transclusioncount.py, and writes them to subpages of Module:Transclusion count/data (see Wikipedia:Bots/Requests for approval/Ahechtbot 6). These pages are usually updated every Sunday, but since running the query is resource intensive, it may be delayed or skipped if Wikipedia server usage is high. Important: If a transclusion count is available in Module:Transclusion count/data, any manually input values will be ignored by this template.

Supporting templates and modules

Redirects

See also

Template counters

TemplateData

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.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
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
Stringdeprecated
discussion page, or use + notation2

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
Stringoptional
Extra informationinfo

When set to non-blank, will insert the value of this parameter into the template text.

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

Stringoptional
form for this templateform

When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.

Suggested values
editnotice
Stringoptional
Expiry for {{editnotice}}expiry

if `form=editnotice`, this will set the expiry parameter of the editnotice.

Dateoptional
systemsystem

no description

Unknownoptional

Visit Template:High-use/doc to edit this text! (How does this work?)
Cookies help us deliver our services. By using our services, you agree to our use of cookies.