Jump to content

Template:High-use/doc

From Wikisource

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

[edit]

{{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 4,502,597 pages so 1% is 45,025 pages)

Examples

[edit]

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

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

Rounding and + notation

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

Editnotice form

[edit]
{{high-use |form=editnotice }}

High risk

[edit]
{{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

[edit]

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.

Supporting templates and modules

[edit]

Redirects

[edit]
{{{2}}}

See also

[edit]

Template counters

[edit]


TemplateData

[edit]
This is the TemplateData documentation for this template used by VisualEditor and other tools.

High-use

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

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

Please directly use {{Used in system}} instead

Unknowndeprecated