Template:High-use/doc - Revision history

imported>Aidan9382: Remove |demo= for now for testing

2022-11-11T06:51:13Z

Remove |demo= for now for testing

@@ Line 5: / Line 5: @@
 This is the {{tlx|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 subpage for templates transcluded onto more than 2,000 pages. For templates transcluded onto more than 100,000 pages, or if the first parameter is set to <code>risk</code>, then a stronger wording is given.
 '''Note''': It is normal that some of the links in the message box are red.
@@ Line 14: / Line 14: @@
 {{tlx |High-use |2=2=''discussion page, or use + notation'' |3=info=''additional text'' }}
-; all parameters
+'''all parameters'''
 <pre style="overflow:auto;">
 {{High-use |1= |2= |info= |demo= |form= |expiry= }}
@@ Line 22: / Line 22: @@
 * <code>1=''number of transclusions''</code>: ''(deprecated)'' 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>info=''extra information''</code>: When set to non-blank, will insert ''extra information'' into the template text.
+* {{para|info|&lt;{{var|extra information}}>}}: When set to non-blank, will insert &lt;{{var|extra information}}> into the template text.
-* <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/]].
+* {{para|demo|&lt;{{var|Template_name}}>}}: Will use the transclusion count for the template at <code><nowiki>[[Template:</nowiki>&lt;{{var|Template_name}}>]]</code> 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}}.
+* {{para|form}}: When set to "<code>editnotice</code>", will display the message using {{tl|editnotice}} instead of {{tl|ombox}}.
-* <code>expiry=</code>: Sets the {{para|expiry}} parameter for {{tl|editnotice}}.
+* {{para|expiry}}: Sets the {{para|expiry}} parameter for {{tl|editnotice}}.
 == Examples ==
@@ Line 50: / Line 51: @@
 === High risk ===
 {{nowiki template demo|code=<nowiki>{{high-use |demo=Yesno }}</nowiki>}}
 {{nowiki template demo|code=<nowiki>{{high-use |risk |demo=High-use }}</nowiki>}}
-{{nowiki template demo|code=<nowiki>{{high-use |risk |Wikipedia talk:High-risk templates |info=This is a very large number! |demo=Yesno }}</nowiki>}}
+{{nowiki template demo|code=<nowiki>{{high-use |risk |Wikipedia talk:High-risk templates |info=This is a very large number! |demo=Yesno}}</nowiki>}}
 == Technical details ==
@@ Line 61: / Line 64: @@
 == Supporting templates and modules ==
-* {{tl|ombox}} which uses {{m2|Message box|ombox}}
+* {{tl|ombox}} which uses {{module link|Message box|ombox}}
-* {{tl|editnotice}} which uses {{m2|Message box|fmbox}}
+* {{tl|editnotice}} which uses {{module link|Message box|fmbox}}
-* {{m2|high-use|main}}
+* {{module link|high-use|main}}
-* {{m2|transclusion count|fetch}}
+* {{module link|transclusion count|fetch}}
 ==Redirects==
@@ Line 93: / Line 96: @@
 [[Category:Documentation header templates]]
 }}</includeonly>

Richardpruen: 1 revision imported

2021-09-01T12:46:45Z

1 revision imported

← Older revision		Revision as of 13:46, 1 September 2021
(No difference)

Wikipedia >DB1729: Restored revision 1025489887 by GKFX (talk): It is, afterall

2021-08-15T00:53:21Z

Restored revision 1025489887 by GKFX (talk): It is, afterall

Show changes

Richardpruen: 1 revision imported: Wikipedia article on Nicotine templates needed

2020-12-12T16:52:38Z

1 revision imported: Wikipedia article on Nicotine templates needed

← Older revision		Revision as of 17:52, 12 December 2020
(No difference)

wikipedia>Michael Bednarek: Undid revision 991677274 by 2604:2D80:F088:6600:C15F:3766:3B14:BD82 (talk): -empty

2020-12-01T12:24:40Z

Undid revision 991677274 by 2604:2D80:F088:6600:C15F:3766:3B14:BD82 (talk): -empty <templatedata>

New page

{{Documentation subpage}}
{{High-use}}

{{#ifeq:{{FULLPAGENAME}}|Template:High-use|
{{lua|Module:High-use|Module:Transclusion count}}}}
This is the {{tl|High-use}} message box.

It is meant to be put at the top of the documentation for templates used on more than 2000 pages.

For templates where the number of pages is more than 100,000 or if the first parameter is set as "risk" a stronger wording is given.

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

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. 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. This value will be ignored if transclusion data is available for the current page (generally for templates with more than 2000 transclusions).
* ''<code>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 paramter 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}} paramter for {{tl|editnotice}}.

=== Examples ===

The full code for a /doc page top can look like this:

<pre>
{{documentation subpage}}
{{high-use}}

</pre>

==== Standard form ====

<pre>
{{high-use| 4,000 }}
{{high-use| 4,000 | Wikipedia talk:High-risk templates }}
{{high-use| | Wikipedia talk:High-risk templates }}
</pre>
{{high-use| 4,000 }}
{{high-use| 4,000 | Wikipedia talk:High-risk templates }}
{{high-use| | Wikipedia talk:High-risk templates }}

==== Rounding and + notation ====

<pre>
{{high-use| 49,500 | demo=A template that does not exist }}
{{high-use| 49,500+ | demo=A template that does not exist }}
</pre>
{{high-use| 49,500 | demo=A template that does not exist }}
{{high-use| 49,500+ | demo=A template that does not exist }}

==== Editnotice form ====

<pre>
{{high-use| form=editnotice }}
</pre>
{{high-use| form=editnotice }}

==== High risk ====

<pre>
{{high-use| demo=Yesno }}
{{high-use| risk }}
{{high-use| risk | Wikipedia talk:High-risk templates | all-pages = yes | info = This is a very large number! }}
</pre>
{{high-use| demo=Yesno }}
{{high-use| risk }}
{{high-use| risk | Wikipedia talk:High-risk templates | all-pages = yes | info = This is a very large number! }}

== Technical details ==

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.

[[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. 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 ==

* {{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 ==

* {{tl|Used in system}} – For templates used in the Wikipedia user interface.
* {{tl|Intricate template}}
* {{tl|pp-template}} – The protection template that usually is put on high-risk templates.
* [[Wikipedia:Template sandbox and test cases]]
* [[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. Not updated since November 2018.
* <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.
* [[Special:PrefixIndex/Module:Transclusion_count/data/]] Template count data used by this template. Broken down by first letter of template and rounded to two or three significant figures. Updated weekly.
<includeonly>{{sandbox other||

[[Category:Documentation header templates]]
}}</includeonly>
<noinclude>
[[pt:Predefini%C3%A7%C3%A3o:Alto_uso/doc]]
[[simple:Template:High-use/doc]]
[[srn:Ankra:High-use/doc]]
[[zh:Template:High-use/doc]]
</noinclude>