Template:High-use/doc
< Template:High-use
Jump to navigation
Jump to search
Revision as of 19:06, 3 June 2019 by wii>Paine Ellsworth (update /doc)
40px | 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 is the {{High-use}} message box.
It is meant to be put at the top of the documentation for templates used on more than 2000 pages.
For templates where the number of pages is set as more than 100,000 or if the first parameter is set as "risk" a stronger wording is given.
Note! It is normal that some of the links in the message box are red.
Contents
Usage
The template can be used as is. But it can also take some parameters:
- First parameter is the number of pages. See toollabs:templatecount/ to find out how many pages use your template. If it is set to "risk" then the template will show a stronger message
- Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.
- if
|all-pages=
is set the percentage of the number of transclusions of the total number of pages is given - if
|info=
is set the specified text is added
Here are some examples:
{{high-use| 40,000 }} {{high-use| 40,000 | Wikipedia talk:High-risk templates }}
40px | This template is used on approximately 40,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
40px | This template is used on approximately 40,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes at Wikipedia talk:High-risk templates before implementing them. |
{{high-use| 41499 }} {{high-use| 41500 }}
40px | This template is used on approximately 41,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
40px | This template is used on approximately 42,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
{{high-use| 40,000,000 | Wikipedia talk:High-risk templates | all-pages = yes }} {{high-use| 40,000,000 | Wikipedia talk:High-risk templates | all-pages = yes | info = This is a very large number! }}
40px | This template is used on approximately 40,000,000 pages, which is ≈4895961% of all pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes at Wikipedia talk:High-risk templates before implementing them. |
40px | This template is used on approximately 40,000,000 pages, which is ≈4895961% of all pages. This is a very large number! To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes at Wikipedia talk:High-risk templates before implementing them. |
{{high-use}} {{high-use| | Wikipedia talk:High-risk templates }}
40px | This template is used on many pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
40px | This template is used on many pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes at Wikipedia talk:High-risk templates before implementing them. |
The full code for a /doc page top can look like this:
{{documentation subpage}} {{high-use| 40000 }} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
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.
Supporting templates and modules
- {{Ombox}} which uses {{#invoke:Message box|ombox}}
- {{High-use/risk}}
- {{High-use/num}}
- {{Str endswith}}
- {{#invoke:String|match}}
See also
- {{used in system}} – For templates used in the Wikipedia user interface.
- {{intricate template}}
- {{pp-template}} – The protection template that usually is put on high-risk templates.
- Wikipedia:Template sandbox and test cases
- Wikipedia:High-risk templates
Template counters
- toollabs:templatecount/ – Easy to use, returns current (real time) transclusion count for a template.
- Wikipedia:Database reports/Templates transcluded on the most pages – Lists the 1000 most transcluded templates. Updated about once a month.
- Special:MostLinkedTemplates – Currently disabled for the English Wikipedia, but still runs for other Wikipedias so might be turned on again some day.
- tools:~dispenser/cgi-bin/embeddedincount.py – Seems to lack human interface, probably meant for programs to call.