Module:High-use/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 15:25, 7 January 2024

This Lua module is used on approximately 59,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Implements {{High-use}}. Uses bot-updated values from subpages of Module:Transclusion_count/data/ when available.

Usage

{{#invoke:High-use|main|1=number of transclusions|2=discussion page, or use + notation|all-pages=|info=|demo=|form=|expiry=}}

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.
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, and the percentage will only display if its greater than 1%.
|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}}.
|system=in system messages: if set, this module looks like {{Used in system}}. Use that template directly as it performs some checks.
|fetch=: if set to false, the module will not attempt to fetch transclusion counts using Module:Transclusion count

Other functions

num: Produces the text and and link to toolforge surrounding the amount of transclusions.
risk: With this function, if risk is passed into the first unnamed parameter, or there are more than 100k transclusions, this will return risk.
text: Returns the body text of this template, with nil or a number of transclusions.

@@ Line 7: / Line 7: @@
 == Usage ==
-{{Mlx|none-use|main|1{{=}}''number of transclusions''|2{{=}}''discussion page, or use + notation''|all-pages{{=}}|info{{=}}|stop{{=}}|form{{=}}|expiry{{=}}}}
+{{Mlx|High-use|main|1{{=}}''number of transclusions''|2{{=}}''discussion page, or use + notation''|all-pages{{=}}|info{{=}}|demo{{=}}|form{{=}}|expiry{{=}}}}
 * ''<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.
@@ Line 13: / Line 13: @@
 * {{para|all-pages|yes}}: Will also output what percentage of all pages use the template. This should only be used for very highly transcluded templates, and the percentage will only display if its greater than 1%.
 * {{para|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".
-* {{para|demo|''file_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/]].
+* {{para|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/]].
-* {{Abnormal|form}}: When set to "editnotice", will display the message using {{tl|editnotice}} instead of {{tl|ombox}}.
+* {{para|form}}: When set to "editnotice", will display the message using {{tl|editnotice}} instead of {{tl|ombox}}.
-* {{Abnormal|expiry}}: Sets the {{para|expiry}} parameter for {{tl|editnotice}}.
+* {{para|expiry}}: Sets the {{para|expiry}} parameter for {{tl|editnotice}}.
-* {{Abnormal|system|''in system messages''}}: if set, this module looks like {{tl|Used in system}}. Use that template directly as it performs some checks.
+* {{para|system|''in system messages''}}: if set, this module looks like {{tl|Used in system}}. Use that template directly as it performs some checks.
-* {{Abnormal|fetch}}: if set to false, the module will not attempt to fetch transclusion counts using [[:Module:Transclusion count]]
+* {{para|fetch}}: if set to false, the module will not attempt to fetch transclusion counts using [[:Module:Transclusion count]]
 === Other functions ===
-; 2
+; num
 : Produces the text and and link to toolforge surrounding the amount of transclusions.
-; Low
+; risk
 : With this function, if <code>risk</code> is passed into the first unnamed parameter, or there are more than 100k transclusions, this will return <code>risk</code>.
 ; text