Permanently protected template

Template:Template for discussion

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

This template is used to nominate a template for discussion. By default, the discussion type is deletion.

Basic usage

Substitute this template onto the template you wish to nominate, i.e. add the following code to the top of the template page and press save.

{{subst:Template for discussion}}

or

{{subst:TfD}}

for short.

Nominating a group of templates

To nominate multiple templates for deletion under the same heading, use the |heading= parameter to specify the heading under which the discussion is taking place. Type the following at the top of each individual template:

{{subst:Template for discussion|heading=HEADING}}

where HEADING is the name of the section heading under which you will list the templates for deletion.

Changing the discussion type

If the discussion type is merger, use template {{TfM}} instead.

If the discussion type would be rename (move), the normally TfD is not the correct process; use the WP:Requested moves (WP:RM) process, by putting {{subst:subst|Template:NewNameHere}} on the template's talk page.

The parameter |action= can be used to replace the output "deletion" in "nominated for deletion" in the small-notice display that appears when the TfD'ed template is transcluded. This parameter [present] has no effect on the display of the TfD template on the template's own "Template:" namespace page. The primary use for this is |action=rename in the special case that a template rename is proposed at the same time as a related deletion or merger, so that discussion is centralized. In such a case, it is not desirable that the delete/merge part of the discussion be at TfD and the rename part be at RM. Nor is it desirable for the template tagged for rename to show up in transcluding pages as "nominated for deletion", which may unduly alarm editors. So use |action=rename in the TfD tag for the template to be moved, e.g.: {{subst:TfD|action=rename}}

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:

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

Module

To nominate a module, set |type=module, add the substituted template to the /doc page. Type the following:

{{subst:Template for discussion|type=module|page={{subst:BASEPAGENAME}}}}

at the top of the module's /doc subpage. The notification looks like this:

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:Template for discussion|type=inline}}

The notification on articles looks like this: ‹The template [[Template:{{{page}}}|{{{page}}}]] is being [[{{{link}}}|considered for deletion]].› 

Tiny

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

{{subst:Template for discussion|type=tiny}}

which will produce the following notification: [[{{{link}}}|‹See Tfd›]]

Sidebar

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

{{subst:Template for discussion|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:Template for discussion|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:

If the default type were to be inserted into the template, the following would result:

Note how this breaks up the paragraph containing the template. Using |type=inline instead generates the following result:

|type=tiny would look like this:

The decision of which type to use should be made on a case-by-case basis. In rare cases, where the insertion of any template is deemed too detrimental to a large number of articles, or if it breaks markup, it might be advisable to disable the notifications completely.

Categorisation

Templates that transclude this template will be added to Category:Templates for deletion.

See also

  • {{Tfm}} - the parallel template for merging
  • {{Tfd2}} - second step in a Tfd process
  • {{Tfdnotice}} - Tfd info on related pages
  • {{Catfd}} - Tfd with corresponding category
  • {{Catfd2}} - add corresponding category to second step in a Tfd process
  • {{Old TfD}} – document results of Tfd on talk pages