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

From blackwiki
Jump to navigation Jump to search
blackwiki>Psneog
imported>DB1729
(Reverted 1 edit by 107.242.125.39 (talk): Unexplained removal)
 
(98 intermediate revisions by 60 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
 +
{{High-use}}
 +
{{#ifeq:{{FULLPAGENAME}}|Template:High-use|
 +
{{lua|Module:High-use}}}}
 +
This is the {{tlx|high-use}} message box.
  
This is the {{tl|high-use}} message box.
+
It is meant to be put at the top of the documentation subpage, for templates transcluded onto more than 2,000 pages. For templates where the number of pages is more than 100,000 or if the first parameter is set to "risk", a stronger wording is given.
  
It is meant to be put at the top of the documentation for templates used on 2000 - 100,000 pages.
+
'''Note''': It is normal that some of the links in the message box are red.
  
For templates used on 100,000 pages or more we instead recommend using {{tl|high-risk}} which has a stronger wording.
+
== Usage ==
 +
{{tlx |1=High-use}}
  
'''Note!''' It is normal that some of the links in the message box are red.
+
{{tlx |1=High-use |2=1=''number of transclusions'' |3=2=''discussion page, or use + notation'' |4=all-pages=''yes/no'' |5=info=''additional text'' }}
  
=== Usage ===
+
; all parameters
 
+
<pre style="overflow:auto;">
The template can be used as is. But it can also take some parameters:
+
{{High-use |1= |2= |all-pages= |info= |demo= |form= |expiry= }}
* First parameter is the number of pages. See [[tools:~jarry/templatecount/]] to find out how many pages use your template.
+
</pre>
* 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.
 
  
Here are some examples:
+
The template can be used as is, and will automatically use bot-updated transclusion counts from [[Special:PrefixIndex/Module:Transclusion_count/data/|subpages of Module:Transclusion_count/data/]], when available. It can also take some parameters:
 +
* <code>1=''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. This value will be ignored, if transclusion data is available for the current page (generally, for templates with more than 2,000 transclusions).
 +
* <code>2=''discussion page, or use + notation''</code>: The second parameter is overloaded. It will cause the number of transclusions to display as "#,###+" instead of "approximately #,###" when set equal to "yes" (without quotes). When used in this manner, values will be rounded down, instead of rounded to the nearest number with the appropriate number of significant figures. When set to any other non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, <code>2=WP:VPT</code> will insert a link to [[WP:VPT]]),
 +
* <code>all-pages=''yes''</code>: Will also output what percentage of all pages use the template. This should only be used for very highly transcluded templates.
 +
* <code>info=''extra information''</code>: When set to non-blank, will insert ''extra information'' into the template text if the template has more than 10,000 transclusions or parameter 1 is set to "risk".
 +
* <code>demo=''Template_name''</code>: Will use the transclusion count for the template at [[Template:Template_name]] instead of detecting what template it is being used on. Capitalization must exactly match the value used in [[Special:PrefixIndex/Module:Transclusion_count/data/]].
 +
* <code>form=</code>: When set to "editnotice", will display the message using {{tl|editnotice}} instead of {{tl|ombox}}.
 +
* <code>expiry=</code>: Sets the {{para|expiry}} parameter for {{tl|editnotice}}.
  
 +
== Examples ==
 +
The full code for a /doc page top usually looks like this:
 
<pre>
 
<pre>
{{high-use| 40,000+ | Wikipedia talk:High-risk templates }}
+
{{documentation subpage}}
 +
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
 +
{{high-use}}
 
</pre>
 
</pre>
  
{{high-use| 40,000+ | Wikipedia talk:High-risk templates }}
+
=== Standard form ===
 +
{{nowiki template demo|code=<nowiki>{{high-use}}</nowiki>}}
  
<pre>
+
{{nowiki template demo|code=<nowiki>{{high-use | |Wikipedia talk:High-risk templates }}</nowiki>}}
{{high-use| 40,000+ }}
+
 
</pre>
+
=== Rounding and + notation ===
 +
{{nowiki template demo|code=<nowiki>{{high-use |49,500 |demo=A template that does not exist }}</nowiki>}}
 +
 
 +
{{nowiki template demo|code=<nowiki>{{high-use |49,500+ |demo=A template that does not exist }}</nowiki>}}
  
{{high-use| 40,000+ }}
+
=== Editnotice form ===
 +
{{nowiki template demo|code=<nowiki>{{high-use |form=editnotice }}</nowiki>}}
  
<pre>
+
=== High risk ===
{{high-use| | Wikipedia talk:High-risk templates }}
+
{{nowiki template demo|code=<nowiki>{{high-use |demo=Yesno }}</nowiki>}}
</pre>
 
  
{{high-use| | Wikipedia talk:High-risk templates }}
+
{{nowiki template demo|code=<nowiki>{{high-use |risk |demo=High-use }}</nowiki>}}
  
The full code for a /doc page top can look like this:
+
{{nowiki template demo|code=<nowiki>{{high-use |risk |Wikipedia talk:High-risk templates |all-pages=yes |info=This is a very large number! |demo=Yesno }}</nowiki>}}
  
<pre>
+
== Technical details ==
{{documentation subpage}}
+
The [[Template:High-use/sandbox|/sandbox]] and [[Template:High-use/testcases|/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.
{{high-use| 40,000+ }}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
</pre>
 
  
=== Technical details ===
+
[[User:Ahechtbot|Ahechtbot]] compiles usage statistics for all templates with 2,000 or more transclusions, using [[User:Ahechtbot/transclusioncount.py]], and writes them to subpages of [[Module:Transclusion count/data]] (see [[Wikipedia:Bots/Requests for approval/Ahechtbot 6]]). These pages are usually updated every Sunday, but since running the query is resource intensive, it may be delayed or skipped, if Wikipedia server usage is high. '''Important''': If a transclusion count is available in [[Module:Transclusion count/data]], any manually input values will be ignored by this template.
  
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.
+
== Supporting templates and modules ==
 +
* {{tl|ombox}} which uses {{m2|Message box|ombox}}
 +
* {{tl|editnotice}} which uses {{m2|Message box|fmbox}}
 +
* {{m2|high-use|main}}
 +
* {{m2|transclusion count|fetch}}
  
=== See also ===
+
==Redirects==
 +
{{columns-list|colwidth=15em|
 +
*{{tl|heavilytranscluded}}
 +
*{{tl|high risk}}
 +
*{{tl|high-risk}}
 +
*{{tl|high use}}
 +
*{{tl|risky template}}
 +
}}
  
* {{tl|used in system}} – For templates used in the Wikipedia user interface.
+
== See also ==
* {{tl|high-risk}} – For the most high-use (high-risk) templates.
+
* {{tl|Intricate template}} – for templates that are complex, using less obvious techniques
* {{tl|high-use}} – For the slightly less high-risk templates.
+
* {{tl|pp-template}} – protection template that usually is put on high-risk templates
* {{tl|intricate template}}
+
* {{tl|Used in system}} – for templates used in the Wikipedia user interface
* {{tl|pp-template}} – The protection template that usually is put on high-risk templates.
 
* [[Wikipedia:Template test cases]]
 
 
* [[Wikipedia:High-risk templates]]
 
* [[Wikipedia:High-risk templates]]
 +
* [[Wikipedia:Template sandbox and test cases]]
  
=== Template counters ===
+
== Template counters ==
 
+
* [[toollabs:templatecount/]] – easy to use, returns current (real time) transclusion count for a template
* [[tools:~jarry/templatecount/]] – Easy to use, returns current (real time) transclusion count for a template.
+
* <span class="plainlinks">[{{fullurl:Special:MostLinkedTemplates|limit=500}} Special:MostLinkedTemplates]</span> – special page search for most transcluded templates
* [[Wikipedia:Database reports/Templates with the most transclusions]] – Lists the 1000 most transcluded templates. Updated about once a month.
+
* [[Special:PrefixIndex/Module:Transclusion_count/data/]] – template count data used by this template that is broken down by first letter of template and rounded to two or three significant figures, and updated weekly
<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.
+
* [[Wikipedia:Database reports/Templates transcluded on the most pages]] – lists the 1000 most transcluded templates, not updated since November 2018
* [[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. (not working anymore) -->
  
<includeonly>
+
<includeonly>{{sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Template namespace templates|{{PAGENAME}}]]
+
[[Category:Documentation header templates]]
[[ar:قالب:استخدام عال]]
+
}}</includeonly>
[[as:Template:High-use]]
 
[[pt:Predefinição:Alto-uso]]
 
[[simple:Template:High-use]]
 
</includeonly>
 

Latest revision as of 22:51, 23 January 2021

This is the {{high-use}} message box.

It is meant to be put at the top of the documentation subpage, for templates transcluded onto more than 2,000 pages. For templates where the number of pages is more than 100,000 or if the first parameter is set to "risk", a stronger wording is given.

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, or use + notation|all-pages=yes/no|info=additional text}}

all parameters
{{High-use |1= |2= |all-pages= |info= |demo= |form= |expiry= }}

The template can be used as is, and will automatically use bot-updated transclusion counts from subpages of Module:Transclusion_count/data/, when available. It can also take some parameters:

  • 1=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. This value will be ignored, if transclusion data is available for the current page (generally, for templates with more than 2,000 transclusions).
  • 2=discussion page, or use + notation: The second parameter is overloaded. It will cause the number of transclusions to display as "#,###+" instead of "approximately #,###" when set equal to "yes" (without quotes). When used in this manner, values will be rounded down, instead of rounded to the nearest number with the appropriate number of significant figures. When set to any other non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, 2=WP:VPT will insert a link to WP:VPT),
  • all-pages=yes: Will also output what percentage of all pages use the template. This should only be used for very highly transcluded templates.
  • info=extra information: When set to non-blank, will insert extra information into the template text if the template has more than 10,000 transclusions or parameter 1 is set to "risk".
  • demo=Template_name: Will use the transclusion count for the template at Template:Template_name instead of detecting what template it is being used on. Capitalization must exactly match the value used in Special:PrefixIndex/Module:Transclusion_count/data/.
  • form=: When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.
  • expiry=: Sets the |expiry= parameter for {{editnotice}}.

Examples

The full code for a /doc page top usually looks like this:

{{documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{high-use}}

Standard form

Template:Nowiki template demo

Template:Nowiki template demo

Rounding and + notation

Template:Nowiki template demo

Template:Nowiki template demo

Editnotice form

Template:Nowiki template demo

High risk

Template:Nowiki template demo

Template:Nowiki template demo

Template:Nowiki template demo

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.

Ahechtbot compiles usage statistics for all templates with 2,000 or more transclusions, using User:Ahechtbot/transclusioncount.py, and writes them to subpages of Module:Transclusion count/data (see Wikipedia:Bots/Requests for approval/Ahechtbot 6). These pages are usually updated every Sunday, but since running the query is resource intensive, it may be delayed or skipped, if Wikipedia server usage is high. Important: If a transclusion count is available in Module:Transclusion count/data, any manually input values will be ignored by this template.

Supporting templates and modules

Redirects

See also

Template counters