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

From blackwiki
Jump to navigation Jump to search
Line 1: Line 1:
== 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'' }}
 
 
; all parameters
 
<pre style="overflow:auto;">
 
{{High-use |1= |2= |all-pages= |info= |demo= |form= |expiry= }}
 
</pre>
 
 
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 ==
 
== Examples ==
 
The full code for a /doc page top usually looks like this:
 
The full code for a /doc page top usually looks like this:

Revision as of 02:20, 6 January 2021

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

Supporting templates and modules

Redirects

See also

Template counters