Template:Tfd/doc

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

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

Usage

Single

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

{{Tfd|{{subst:PAGENAME}}}}

‹ The template below (Tfd/doc) is being considered for deletion. See templates for discussion to help reach a consensus.›

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

Multiple

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

{{Tfd|{{subst:PAGENAME}}|NameHeader}}

where NameHeader is the name of the header under which you will list the templates for deletion, in here.

Inline

To nominate inline templates, set the type parameter to inline. This will help with formatting issues that are occurring when the large Tdf notification is displayed.

{{Tfd|{{subst:PAGENAME}}|type=inline}}

‹The template Tfd/doc is being considered for deletion.›

Tiny

To use even smaller notifications, for inline template nominations, set the type parameter to tiny.

{{Tfd|{{subst:PAGENAME}}|type=tiny}}

‹See Tfd›

To nominate templates that are used as sidebars, such as infoboxes, set the type parameter to sidebar, infobox or box.

{{Tfd|{{subst:PAGENAME}}|type=sidebar}}

‹ The template (Tfd/doc) is being considered for deletion. ›

When using the sidebar type, you can set the width of the notification, by using the width parameter.

{{Tfd|{{subst:PAGENAME}}|type=sidebar|width=230}}

‹ The template (Tfd/doc) is being considered for deletion. ›

Disabled

This option completely disables transclusion of the discussion notification. Use it when everything else fails.

{{Tfd|{{subst:PAGENAME}}|type=disabled}}

Which type should be used?

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 default type were to be inserted into the template, the following would result:

‹ The template below is being considered for deletion. See templates for discussion to help reach a consensus. ›

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

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

Using

{{Tfd|Raisins|Fruit templates|type=inline}}

instead generates the following result:

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

As can be seen, the downside is a greater degree of interference with the article's text, so the decision of which type to use, should be made on a case-by-case basis. In the rare case, where the insertion of any template is deemed too detrimental to a large number of articles, it might be advisable to completely disable the notifications.