Template:Frequently substituted/doc

This template may be placed on the template doc page of templates that are substituted very frequently, such as block templates, user warning templates, and welcome templates.

Usage

{{Frequently substituted}}
{{Frequently substituted|freqlink=yes}}

Parameters

There are two parameters, both optional:

• |freqlink=y – links the bolded string "very frequently" to an advanced search query which returns the number of times the template has been substituted, and the list of pages it appears on.
• |sns=namespace – restricts the advanced search to the given namespace; e.g., User talk; default: all namespaces.

Details

Parameter |freqlink=y generates a Cirrus search link that returns pages having the template name in Html hidden text on the page. That is, 'Template:Foo' must substitute <!-- Template:Foo --> onto the target page in order to be counted. (This category contains a non-exhaustive list of templates with hidden id's.) These search links typically display results in a couple of seconds, but for templates that have hundreds of thousands of substitutions (e.g., {{Welcome}}, {{Uw-vandalism1}}, etc.}}), the link may take up to 20 seconds, or even time out. The performance may be improved in some cases by using param |sns= to restrict the range of namespaces to search.

Some frequently substituted templates, such as most welcome templates and user warning templates, already generate this Cirrus search link (typically in the Notes section on the doc page).

See also

• {{Always substitute}}
• {{May be substituted}}
• {{Never substitute}}
• {{Substitution}}
• Module:Unsubst