Template:High-use

From ISTP Computing
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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.

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 | Taswin talk:High-risk templates }}
{{high-use| 41499 }}
{{high-use| 41500 }}
{{high-use| 40,000,000 | Taswin talk:High-risk templates | all-pages = yes }}
{{high-use| 40,000,000 | Taswin talk:High-risk templates | all-pages = yes | info = This is a very large number! }}
{{high-use}}
{{high-use| | Taswin talk:High-risk templates }}

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 [[Taswin: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

See also

Template counters