Template:High-use/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:High-use (see that page for the template itself).
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.

[edit] Usage

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+ | Wikipedia talk:High-risk templates }}
This template is used on 300,000+ pages
To avoid any disruptions and to save server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. As a courtesy to other users, please discuss any changes at Wikipedia talk:High-risk templates before implementing them.		 
{{high-use| 300,000+ }}
This template is used on 300,000+ pages
To avoid any disruptions and to save server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. As a courtesy to other users, please discuss any changes at the talk page before implementing them.		 
{{high-use| | Wikipedia talk:High-risk templates }}
This template is used on many pages
To avoid any disruptions and to save server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. As a courtesy to other users, please discuss any changes at Wikipedia 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 -->

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

[edit] See also