Template:Tfm/doc

This is a documentation subpage for Template:Tfm.
It may contain usage information, categories and other content that is not part of the original template page.

Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. Thank you.

If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify XFDcloser's users and maintainers at Wikipedia talk:XFDcloser as a courtesy, as this template is used in the standard installation of XFDcloser. Thank you!

If you plan to make breaking changes to this template, move it, change scope, or nominate it for deletion or deprecation, please notify the Article Alerts project at Wikipedia talk:Article alerts as a courtesy, as this page is used by the AAlertBot bot to detect and report pages. Thank you!

This template is used to nominate other templates for merging.

Usage

To nominate a single template, copy and paste the following code at the top of the template:

{{subst:tfm|OtherTemplate}}

Note: OtherTemplate should be replaced by the name of the other template to be merged, excluding the prefix Template: (or Module:).

To nominate multiple templates for merging under the same header, type the following at the top of each individual template:

{{subst:tfm|OtherTemplate|heading=NameOfHeading}}

where NameOfHeading is the name of the section heading under which you will list the templates for merging at TfD. You can also spell this |header=.

Display on articles

Unless you do something unusual such as enclosing in noinclude tags, articles that use the nominated template will provide a notification and link to the discussion. By default the article will show the following just above the display of the nominated template:

‹ The template below (Tfm) is being considered for merging with OtherTemplate. See templates for discussion to help reach a consensus. ›

There are various other options, specified by the |type= parameter.

Inline

To nominate inline templates, set |type=inline. This will help with formatting issues that occur when the large notification is displayed. Type the following:

{{subst:Tfm|OtherTemplate|type=inline}}

The notification on articles looks like this: ‹The template Tfm is being considered for merging.›

Tiny

To use even smaller notifications, for inline template nominations, set |type=tiny. Type the following

{{subst:Tfm|OtherTemplate|type=tiny}}

which will produce the following notification: ‹See TfM›

To nominate templates that are used as sidebars, such as infoboxes, specify |type=sidebar, i.e.

{{subst:Tfm|OtherTemplate|type=sidebar}}

which produces:

You can alternatively use |type=infobox or |type=box to produce the same result.

Disabled

Finally it is possible to disable the notification completely by typing |type=disabled. You can use this when everything else fails.

{{subst:Tfm|OtherTemplate|type=disabled}}

which outputs nothing at all on all transclusions of the template.

Deduplication

By default, if multiple notices would be displayed within a single element such as a paragraph or table, all but the first will be hidden. To show all of them, set |dedup=no.

For example, by default a sentence might appear as

Among her favorite fruits were ‹See TfM›apples, ‹See TfM›avocados, ‹See TfM›bananas, ‹See TfM›dried grapes, ‹See TfM›oranges, ‹See TfM›peaches and ‹See TfM›pears.

This is useful when the same template is used more than once, but can hide notices if multiple templates under discussion are used together. In these situations use |dedup=no: