Template:High-use/doc: Difference between revisions
Content deleted Content added
m Commas. |
Adapt local policies, template notices and guidance for independent Elite Dangerous Wiki; preserve index layout |
||
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. For templates transcluded onto less than 2000 pages, it provides a link to a page with the number of transclusions. Many template users and editors want this info. For templates transcluded onto more than 2,000 pages, it shows the number of transclusions directly. For templates transcluded onto more than 100,000 pages, or if the first parameter is set to <code>risk</code>, a stronger wording is given. See [[
'''Note''': It is normal for some of the links in the message box to be red.
Line 21:
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>: ''(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 [[
* {{para|info|<{{var|extra information}}>}}: When set to non-blank, will insert <{{var|extra information}}> into the template text.
* {{para|demo|<{{var|Template_name}}>}}: Will use the transclusion count for the template at <code><nowiki>[[Template:</nowiki><{{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/]].
Line 61:
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 [[
== Supporting templates and modules ==
Line 77:
* {{tl|pp-template}} – protection template that usually is put on high-risk templates
* {{tl|Used in system}} – for templates used in the Wikipedia user interface
* {{tl|R from high-use template}} – an [[
* [[
* [[
== Template counters ==
Line 85:
* <span class="plainlinks">[{{fullurl:Special:MostLinkedTemplates|limit=500}} Special:MostLinkedTemplates]</span> – 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
* [[
<!-- * [[tools:~dispenser/cgi-bin/embeddedincount.py]] – Seems to lack human interface, probably meant for programs to call. (not working anymore) -->
Line 96:
{{TemplateData header}}
<templatedata>{
"params": {
"1": {▼
▲ "label": "number of transclusions (DEPRECATED)",
▲ "description": "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.",
▲ "type": "string",
▲ "suggestedvalues": [
],
▲ "risk"
},
▲ "deprecated": "This value will be ignored, if transclusion data is available for the current page."
▲ "label": "discussion page, or use + notation",
▲ "description": "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": {
▲ "label": "Extra information",
▲ "description": "When set to non-blank, will insert the value of this parameter into the template text.",
},
▲ "type": "content"
▲ "demo": {
▲ "label": "template name (intended for demo purposes)",
▲ "description": "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/.",
},
▲ "type": "string"
▲ "form": {
▲ "label": "form for this template",
▲ "description": "When set to \"editnotice\", will display the message using {{editnotice}} instead of {{ombox}}.",
▲ "type": "string",
▲ "suggestedvalues": [
" "
▲ "editnotice",
]
},
▲ "expiry": {
▲ "label": "Expiry for {{editnotice}}",
"type": "date"
▲ "description": "if `form=editnotice`, this will set the expiry parameter of the editnotice.",
},
▲ "type": "date"
▲ "system": {
▲ "description": "Please directly use {{Used in system}} instead",
}
▲ "deprecated": true
▲ "description": "This is the {{high-use}} message box.\n\nIt 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.\n\nNote: It is normal that some of the links in the message box are red. ",
}</templatedata>▼
▲ "format": "inline"
▲</templatedata>
| |||