ਫਰਮਾ:High-use/doc
This is a documentation subpage for ਫਰਮਾ:High-use. It contains usage information, categories and other content that is not part of the original ਫਰਮਾ page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
ਇਹ ਫਰਮਾ ਹੇਠ ਲਿਖੇ ਲੂਆ ਨੂੰ ਵਰਤਦਾ ਹੈ: |
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 transcluded onto more than 100,000 pages, or if the first parameter is set to risk
, then 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|2=discussion page, or use + notation|info=additional text}}
- all parameters
{{High-use |1= |2= |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
: (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).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),|info=<extra information>
: When set to non-blank, will insert <extra information> into the template text.|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}}.|no-percent=yes
: suppresses automatic 'percent of all pages' annotation; 'percent of all pages' annotation is automatically added when template is used in more than 1% of all pages (currently{{NUMBEROFPAGES}}
is 63,377 pages so 1% is 633 pages)
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
[ਸੋਧੋ]{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
Rounding and + notation
[ਸੋਧੋ]{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
Editnotice form
[ਸੋਧੋ]{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
High risk
[ਸੋਧੋ]{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
{{High-use}}
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{High-use/sandbox}}
Error: expandTemplate: template "High-use/sandbox" does not exist
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.
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
[ਸੋਧੋ]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
- 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
TemplateData
[ਸੋਧੋ]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 transcluded onto more than 100,000 pages, or if the first parameter is set to risk, then a stronger wording is given. Note: It is normal that some of the links in the message box are red.
ਮਾਪਦੰਡ | ਵੇਰਵਾ | ਕਿਸਮ | ਦਰਜਾ | |
---|---|---|---|---|
number of transclusions (DEPRECATED) | 1 | 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.
| String | deprecated |
discussion page, or use + notation | 2 | 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)
| String | optional |
Extra information | info | When set to non-blank, will insert the value of this parameter into the template text. | Content | optional |
template name (intended for demo purposes) | demo | 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/. | String | optional |
form for this template | form | When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.
| String | optional |
Expiry for {{editnotice}} | expiry | if `form=editnotice`, this will set the expiry parameter of the editnotice. | Date | optional |
system | system | Please directly use {{Used in system}} instead | Unknown | deprecated |