Template:Tfm-inline/doc

This template is used to nominate inline templates for merging. Templates that transclude this template will be added to Category:Templates for merging.

Usage

 * Single

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




 * This code will work as is; there is no need to replace PAGENAME with the actual page name.


 * Note: Do not add the name of the template to merge with.


 * Multiple

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

where NameHeader is the name of the header under which you will list the templates for merging.


 * Tiny

This template has a tiny parameter, which when set to yes, renders an ultrashort form.



Example
For example, suppose that a template called Raisins outputs the link "dried grapes". Here's how it might appear in an article:
 * Among her favorite fruits were apples, avocados, bananas, dried grapes, oranges, peaches and pears.

If the standard Tfm tag were to be inserted into the template, the following would result:

&lsaquo; The template below is being considered for merging. See templates for discussion to help reach a consensus. &rsaquo;
 * Among her favorite fruits were apples, avocados, bananas, dried grapes, oranges, peaches and pears.

Obviously, it's impossible for the reader to identify the merge candidate.

Using instead generates the following result:


 * Among her favorite fruits were apples, avocados, bananas, ‹The template Raisins is being considered for merging› dried grapes, oranges, peaches and pears.

As can be sees, the downside is a greater degree of interference with the article's text, so the decision of which tag to use should be made on a case-by-case basis. In the rare case, where the insertion of either template is deemed too detrimental to a large number of articles, it might be advisable to place the notice on the template's talk page instead.