Template:High-use/doc: Difference between revisions
meta>Davidgothberg m Reverted edits by 123.232.216.109 (talk) to last version by Mormegil |
meta>Davidgothberg Making it clearer that this message box is meant for the highest used templates. |
||
| Line 4: | Line 4: | ||
This is the {{tl|high-use}} message box. | This is the {{tl|high-use}} message box. | ||
It | It is meant to be put at the top of the documentation for the most high-use (high-risk) templates. | ||
'''Note!''' It is normal that some of the links in the message box are red. | '''Note!''' It is normal that some of the links in the message box are red. | ||
Revision as of 23:35, 26 November 2008
 | This is a documentation subpage for Template:High-use. It may contain 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 the most high-use (high-risk) templates.
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 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 3,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 at Wikipedia talk:High-risk templates before implementing them. |
{{high-use| 300,000+ }}
| This template is used on 3,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| | Wikipedia talk:High-risk templates }}
| This template is used on approximately 3,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 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 -->
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.
See also
- {{intricate template}}
- Wikipedia:Template test cases
- Wikipedia:High-risk templates
{{pp-template|small=yes}}– The protection template that usually is put on high-use templates.
