Template:Find substed

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Find substed/doc" to edit its documentation if it is available. (How does this work?)

Generate a Cirrus search url that returns pages containing the name of a given substed template, as long as the template places its own name on the page embedded in a hidden comment, as for example, the user warning and welcome templates typically do.

Usage

{{Find substed}}
{{fsubst|Template name}}
{{fsubst|Template name|year=YYYY}}
{{fsubst|Some string|sns=Help talk}}

Parameters

There are four optional parameters:

• |1= – name of template or string to search for (optional; default = {{PAGENAME}}; i.e., name of page where it appears)
• |year= – restricts the search to the year you specify (optional; default = all years; see § Notes)
• |ns= – namespace name of template or string (optional; default = Template
• |sns= – search namespace: what namespace to search (list) for the given template (optional; default = User talk; see § Notes)

  the special value all (i.e., |sns=all ) may be used to search all namespaces simultaneously

When used with no parameters, it searches the User talk space for hidden text containing the name of the page it is transcluded on.

Interactions: for interaction of certain parameters, such as sns and year, see the § Notes section below.

Examples

• [{{find substed}} search] ⟶ search User talk for this template (0 results)
• [{{find substed|uw-vandalism4}} search] ⟶ search User talk for template uw-vandalism4
• [{{find substed|uw-vandalism4|year=2026}} search] ⟶ search User talk for template uw-vandalism4
• [{{fsubst|uw-spam4im}} search] ⟶ search User talk for uw-spam4im
• [{{fsubst|Uw-c&pmove}} search] ⟶ search User talk for Uw-c&pmove
• [{{fsubst|Uw-c&pmove|year=2024}} search] ⟶ search User talk for Uw-c&pmove
• [{{fsubst|Notified|sns=Wikipedia|year=2022}} search] ⟶ search Wikipedia namespace for Notified     (invalid; see § Year search issues)
• [{{fsubst|Notified|sns=all}} search] ⟶ search all namespaces for Notified
• [{{find substed|RFDNote|sns=Help talk}} search] ⟶ search Help talk for RFDNote

Notes

Method

This template generates a Cirrus search url that returns pages containing a template name embedded in Html hidden text delimiters, i.e., the page must contain the following hidden text label:

• <!-- Template:Foo bar -->

where the template being searched for is 'Foo bar' (if param 1 = Foo bar, otherwise, {{PAGENAME}}). The Html begin and end delimiters must be exactly as shown, and there may be any number of blank spaces (zero or more) between the delimiter and the Template name, front and back. There may be two or three hyphens in the delimiters. There may not be any other content between the delimiters.

Performance and timeout

This template uses Cirrus regular expression search, which can be slow for queries that return a great many results, and may time out after 20 seconds, usually with a partial result set returned. If the query times out or doesn't produce as many results as you believe it should, you may be able to produce more results by trying again at a time when the server is under less load. Another way to avoid a timeout in some cases, is by using the by-year search links, which will reduce the number of results. Some sample timings: {{uw-v4}}: 238,144 results in approx. 5 seconds; {{uw-v3}}: 425,295 = ~7"; {{uw-v2}}: 808,617 = ~10"; {{uw-v1}}: 2,490,016 = ~17" (timed out; results incomplete).

False positives and negatives

Sometimes, the hidden tag does not match the template name. (This sometimes occurs after page moves, or copy/pasting when creating a new template.) You may be able to remedy this by using positional param 1 to specify the hidden tag. If the page was moved at some point and the tag was changed, you may end up with some substed pages with one tag, some with another; a workaround in this case is to use the template twice: one of them will need to use param 1.

A more complex case occurs when someone uses the Cirrus link to search for substitutions of a template copied from another without a tag change; this will turn up instances of the copied template as a false positive, skewing the count of actual substitutions of the older one. The flip side of that is underreporting of substed templates who have or used to have the wrong tag. This includes misspellings, such as "Teahouse_AfC_invitaiton" [sic] which can be found by using param 1 set to the misspelled token: {{fsubst|Teahouse_AfC_invitaiton}}, which gives 38,000 results for decade-old substitutions, until the spelling of the tag was corrected at some point. (But those 38,000 misspelled results were substed, so they are never going away.)

Year search issues

Using the by-year search links successfully depends on the appearance of the year as part of a signature which almost invariably appears after the template. This template cannot find substed templates that contain no signature, or which contain a signature without a timestamp. Because pages in subject namespaces generally contain no signature, it usually does not make sense to use the by-year search links when specifying any subject namespace, with the exception of noticeboards and other boards like WP:Xfd in project space which typically do contain dated signatures.

The search string used to find templates substed in a given year depends on the hidden template name string at the end of the template, and on a signature containing the date following it, in that order, with no intervening newline. A very few templates, such as {{Notified}}, have the two elements but in the reverse order, with the timestamped signature first and the hidden template id afterward. Such templates cannot be found by this template, but they are few.

---

See also

• {{Find substed templates notice}}
• {{Single notice}}
• {{Templates notice}}
• Wikipedia:Template index/User talk namespace

Template:Find substed invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.