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

From Kerbal Space Program Wiki
Jump to: navigation, search
m
m
 
(4 intermediate revisions by the same user not shown)
Line 33: Line 33:
  
 
<pre>
 
<pre>
{{high-use| 4000 }}
+
{{high-use|4000}}
{{high-use| 4000 | Wikipedia talk:High-risk templates }}
+
{{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}}
{{high-use| 4000 | Wikipedia talk:High-risk templates }}
+
{{high-use|4000|Wikipedia talk:High-risk templates}}
{{high-use| | Wikipedia talk:High-risk templates }}
+
{{high-use||Wikipedia talk:High-risk templates}}
  
 
=== High risk ===
 
=== High risk ===
  
 
<pre>
 
<pre>
{{high-use| demo=Yesno }}
+
{{high-use|risk}}
{{high-use| risk }}
+
{{high-use|risk|Wikipedia talk:High-risk templates|info=This is a very large number!}}
{{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 }}
+
{{high-use|risk|Wikipedia talk:High-risk templates|info=This is a very large number!}}
{{high-use| risk | Wikipedia talk:High-risk templates | info = This is a very large number! }}
 
  
 
=== Technical details ===
 
=== Technical details ===
Line 66: Line 64:
 
=== Template counters ===
 
=== 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.
 
* [[Wikipedia:Database reports/Templates transcluded on the most pages]] – Lists the 1000 most transcluded templates. Updated about once a month.
 
*  <span class="plainlinks">[{{fullurl:Special:MostLinkedTemplates|limit=500}} Special:MostLinkedTemplates]</span> – Currently disabled for the English Wikipedia, but still runs for other Wikipedias so might be turned on again some day.
 
*  <span class="plainlinks">[{{fullurl:Special:MostLinkedTemplates|limit=500}} Special:MostLinkedTemplates]</span> – 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.
 
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Latest revision as of 23:56, 6 March 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|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