Difference between revisions of "Template:High-use/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(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 2000 - 100,000 pages.
+
It is meant to be put at the top of the documentation for templates used on more than 200 pages.
  
For templates used on 100,000 pages or more we instead recommend using {{tl|high-risk}} which has a stronger wording.
+
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 ===
+
== 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:  
* First parameter is the number of pages. See [[toollabs:templatecount/]] to find out how many pages use your template.
+
* ''<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.
* 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.
+
* ''<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".
  
Here are some examples:
+
== Examples ==
  
<pre>
+
The full code for a /doc page top can look like this:
{{high-use| 40,000+ | Wikipedia talk:High-risk templates }}
 
</pre>
 
 
 
{{high-use| 40,000+ | Wikipedia talk:High-risk templates }}
 
  
 
<pre>
 
<pre>
{{high-use| 40,000+ }}
+
{{documentation subpage}}
 +
{{high-use}}
 +
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
</pre>
 
</pre>
  
{{high-use| 40,000+ }}
+
=== 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 }}
  
The full code for a /doc page top can look like this:
+
=== High risk ===
  
 
<pre>
 
<pre>
{{documentation subpage}}
+
{{high-use| demo=Yesno }}
{{high-use| 40,000+ }}
+
{{high-use| risk }}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{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|high-risk}} – For the most high-use (high-risk) templates.
 
* {{tl|high-use}} – For the slightly less high-risk templates.
 
 
* {{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 GO HERE AND INTERWIKIS TO WIKIDATA, THANK YOU! -->
+
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Template namespace templates|{{PAGENAME}}]]
+
[[Category:Template namespace templates]]
 
</includeonly>
 
</includeonly>

Revision as of 11:39, 29 February 2020

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.

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 }}

High risk

{{high-use| demo=Yesno }}
{{high-use| risk }}
{{high-use| risk | Wikipedia talk:High-risk templates | info = This is a very large number! }}

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

Template counters