Template:High-use/doc
Jump to navigation
Jump to search
 | 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 can be put at the top of the documentation for any high-use or high-risk template.
Note! It is normal that some of the links in the message box are red.
Usage[edit source]
The template can be used as is. But it can also take some parameters:
- First parameter is the number of pages. See Special:MostLinkedTemplates to find out how many pages use your template.
- Second parameter is the name of some other talk page if you want discussion to be made there instead. A better option might be to redirect the talkpage of your template to that other talkpage.
Here are some examples:
{{high-use| 300,000+ | PBC talk:High-risk templates }}
 | This template is used on many pages. To avoid major disruption and server load, 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 PBC talk:High-risk templates before implementing them. |
{{high-use| 300,000+ }}
| This template is used on many pages. To avoid major disruption and server load, 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| | PBC talk:High-risk templates }}
 | 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 PBC talk:High-risk templates before implementing them. |
When this template is placed on a template's /doc page it can be nice to put it within <includeonly> tags so it only gets visible on the template page. The full code for a /doc page top then can look like this:
{{Documentation subpage}}
<includeonly>{{high-use| 300,000+ }}</includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
Technical details[edit source]
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.
See also[edit source]