Difference between revisions of "Template:High-use/doc"
From Kerbal Space Program Wiki
(Import from Wikipedia (CC BY-SA license)) |
m |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS TO WIKIDATA. --> | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS TO WIKIDATA. --> | ||
| − | |||
This is the {{tl|high-use}} message box. | This is the {{tl|high-use}} message box. | ||
| − | It is meant to be put at the top of the documentation for templates used on | + | It is meant to be put at the top of the documentation for templates used on more than 200 pages. |
| − | For templates | + | For templates where the number of pages is more than 1000 pages, we instead recommend setting the first parameter to "risk" which has a stronger wording. |
'''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. | ||
| − | === | + | == Usage == |
| + | |||
| + | {{tlx|1=High-use}} | ||
| + | |||
| + | {{tlx|1=High-use|2=1=''number of transclusions''|3=2=''discussion page''|4=info=''additional text''}} | ||
The template can be used as is. But it can also take some parameters: | The template can be used as is. But it can also take some parameters: | ||
| − | * | + | * ''<code>number of transclusions</code>'': The first parameter is either a static number of times the template has been transcluded, or the word "risk" (without quotes) to display "a very large number of" instead of the actual value. |
| − | + | * ''<code>discussion page</code>'': The second parameter is overloaded. When set to any non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, the name of some other talk page where you want the discussion to be.) | |
| + | * <code>info=''extra information''</code>: When set to non-blank, will insert ''extra information'' into the template text if parameter 1 is set to "risk". | ||
| − | + | == Examples == | |
| − | + | The full code for a /doc page top can look like this: | |
| − | |||
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
| − | {{high-use | + | {{documentation subpage}} |
| + | {{high-use}} | ||
| + | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
</pre> | </pre> | ||
| − | + | === Standard form === | |
<pre> | <pre> | ||
| + | {{high-use| 4000 }} | ||
| + | {{high-use| 4000 | Wikipedia talk:High-risk templates }} | ||
{{high-use| | Wikipedia talk:High-risk templates }} | {{high-use| | Wikipedia talk:High-risk templates }} | ||
</pre> | </pre> | ||
| − | + | {{high-use| 4000 }} | |
| + | {{high-use| 4000 | Wikipedia talk:High-risk templates }} | ||
{{high-use| | Wikipedia talk:High-risk templates }} | {{high-use| | Wikipedia talk:High-risk templates }} | ||
| − | + | === High risk === | |
<pre> | <pre> | ||
| − | {{ | + | {{high-use| demo=Yesno }} |
| − | {{high-use| | + | {{high-use| risk }} |
| − | + | {{high-use| risk | Wikipedia talk:High-risk templates | info = This is a very large number! }} | |
</pre> | </pre> | ||
| + | {{high-use| demo=Yesno }} | ||
| + | {{high-use| risk }} | ||
| + | {{high-use| risk | Wikipedia talk:High-risk templates | info = This is a very large number! }} | ||
=== Technical details === | === Technical details === | ||
| Line 51: | Line 59: | ||
* {{tl|used in system}} – For templates used in the Wikipedia user interface. | * {{tl|used in system}} – For templates used in the Wikipedia user interface. | ||
| − | |||
| − | |||
* {{tl|intricate template}} | * {{tl|intricate template}} | ||
* {{tl|pp-template}} – The protection template that usually is put on high-risk templates. | * {{tl|pp-template}} – The protection template that usually is put on high-risk templates. | ||
| − | * [[Wikipedia:Template sandbox and test cases]] | + | * [[w:Wikipedia:Template sandbox and test cases]] |
| − | * [[Wikipedia:High-risk templates]] | + | * [[w:Wikipedia:High-risk templates]] |
=== Template counters === | === Template counters === | ||
| Line 65: | Line 71: | ||
* [[tools:~dispenser/cgi-bin/embeddedincount.py]] – Seems to lack human interface, probably meant for programs to call. | * [[tools:~dispenser/cgi-bin/embeddedincount.py]] – Seems to lack human interface, probably meant for programs to call. | ||
| − | <includeonly> | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
| − | <!-- | + | <!-- Categories below this line, please; interwikis at Wikidata --> |
| − | [[Category:Template namespace templates | + | [[Category:Template namespace templates]] |
</includeonly> | </includeonly> | ||
Revision as of 11:39, 29 February 2020
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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 200 pages.
For templates where the number of pages is more than 1000 pages, we instead recommend setting the first parameter to "risk" which has a stronger wording.
Note! It is normal that some of the links in the message box are red.
Contents
Usage
{{High-use}}
{{High-use|1=number of transclusions|2=discussion page|info=additional text}}
The template can be used as is. But it can also take some parameters:
-
number of transclusions: The first parameter is either a static number of times the template has been transcluded, or the word "risk" (without quotes) to display "a very large number of" instead of the actual value. -
discussion page: The second parameter is overloaded. When set to any non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, the name of some other talk page where you want the discussion to be.) -
info=extra information: When set to non-blank, will insert extra information into the template text if parameter 1 is set to "risk".
Examples
The full code for a /doc page top can look like this:
{{documentation subpage}}
{{high-use}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
Standard form
{{high-use| 4000 }}
{{high-use| 4000 | Wikipedia talk:High-risk templates }}
{{high-use| | Wikipedia talk:High-risk templates }}
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on no 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 risk
{{high-use| demo=Yesno }}
{{high-use| risk }}
{{high-use| risk | Wikipedia talk:High-risk templates | info = This is a very large number! }}
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on no 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. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on a very large number of 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 on the talk page before implementing them. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on a very large number of 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. |
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
- {{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.
- w:Wikipedia:Template sandbox and test cases
- w: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.
