Template:High-use/doc
![]() | This is a documentation subpage for Template:High-use. It contains usage information, categories, and other content that is not part of the original template page. |
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | This template uses Lua: |
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 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=WS:VP
will insert a link to WS:VP),|info=<[[extra information{{{2}}} {{{3}}}{{{4}}} var. {{{5}}}|extra information. {{{3}}}. var. {{{5}}}]] –>
: When set to non-blank, will insert <[[extra information{{{2}}} {{{3}}}{{{4}}} var. {{{5}}}|extra information. {{{3}}}. var. {{{5}}}]] –> into the template text.|demo=<[[Template_name{{{2}}} {{{3}}}{{{4}}} var. {{{5}}}|Template_name. {{{3}}}. var. {{{5}}}]] –>
: Will use the transclusion count for the template at[[Template:<[[Template_name{{{2}}} {{{3}}}{{{4}}} var. {{{5}}}|Template_name. {{{3}}}. var. {{{5}}}]] –>]]
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,976,829 pages so 1% is 19,768 pages)
Examples
editThe 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}}
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{high-use | |Wikispecies:Village Pump }}
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes at Wikispecies:Village Pump before implementing them. |
Rounding and + notation
edit{{high-use |49,500 |demo=A template that does not exist }}
![]() | This template is used on approximately 50,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{high-use |49,500+ |demo=A template that does not exist }}
![]() | This template is used on 49,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Editnotice form
edit{{high-use |form=editnotice }}
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
High risk
edit{{high-use |demo=Yesno }}
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{high-use |demo=Yesno |no-percent=yes}}
![]() | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{high-use |risk |demo=High-use }}
![]() | This template is used on a very large number of pages. To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
{{high-use |risk |Wikispecies:Village Pump |info=This is a very large number! |demo=Yesno}}
![]() | This template is used on a very large number of pages. This is a very large number! To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes at Wikispecies:Village Pump before implementing them. |
Technical details
editThe /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.
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
edit{{Ombox}}
which uses {{#invoke:Message box|ombox}}{{Editnotice}}
which uses {{#invoke:Message box|fmbox}}- {{#invoke:high-use|main}}
- {{#invoke:transclusion count|fetch}}
Redirects
edit{{Heavilytranscluded}}
{{High risk}}
{{High-risk}}
{{High use}}
{{Risky template}}
See also
edit{{Intricate template}}
– for templates that are complex, using less obvious techniques{{Pp-template}}
– protection template that usually is put on high-risk templates{{Used in system}}
– for templates used in the Wikipedia user interface- en:Wikipedia:High-risk templates
- en:Wikipedia:Template sandbox and test cases
Template counters
edit- toollabs:linkcount/ – easy to use, returns current (real time) transclusion count for a template
- Special:MostLinkedTemplates – special page search for most transcluded templates
- 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
TemplateData
editThis 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.
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.
| 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=WS:VP will insert a link to WS:VP)
| 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}}.
| String | optional |
Expiry for {{editnotice}} | expiry | if `form=editnotice`, this will set the expiry parameter of the editnotice. | Date | optional |
system | system | no description | Unknown | optional |