Difference between revisions of "Template:High-use/doc"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Usage == | == Usage == | ||
{{tlx |1=High-use}} | {{tlx |1=High-use}} | ||
Revision as of 02:19, 6 January 2021
Contents
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:VPTwill 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
Rounding and + notation
Editnotice form
High risk
Supporting templates and modules
- {{ombox}} which uses {{#invoke:Message box|ombox}}
- {{editnotice}} which uses {{#invoke:Message box|fmbox}}
- {{#invoke:high-use|main}}
- {{#invoke:transclusion count|fetch}}
Redirects
- {{heavilytranscluded}}
- {{high risk}}
- {{high-risk}}
- {{high use}}
- {{risky template}}
See also
- {{Intricate template}} – for templates that are complex, using less obvious techniques
- {{pp-template}} – protection template that usually is put on high-risk templates
- {{Used in system}} – for templates used in the Wikipedia user interface
- Wikipedia:High-risk templates
- Wikipedia:Template sandbox and test cases
Template counters
- toollabs:templatecount/ – easy to use, returns current (real time) transclusion count for a template
- Special:MostLinkedTemplates – special page search for most transcluded templates
- 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
- Wikipedia:Database reports/Templates transcluded on the most pages – lists the 1000 most transcluded templates, not updated since November 2018