Template:Template for discussion/sandbox

This is the template sandbox page for Template:Template for discussion (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Shortcut

{{subst:tfdTemplate:Tfd}}

This template should always be substituted (i.e., use {{subst:Template for discussion}}).

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!

Substituting this template creates a dated version, you should not substitute the dated version.

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

1 Basic usage
2 Nominating a group of templates
3 Changing the discussion type
4 Display on articles
5 Which type should be used?
6 Deduplication
7 Categorisation
8 See also

Basic usage

edit

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}}

{{subst:TfD}}

for short. If the template is protected and you cannot add the nomination yourself, please edit the template's talk page and add a template request using {{TPER}}.

Nominating a group of templates

edit

To nominate multiple templates for deletion under the same heading, use the |heading= (AKA |header=) parameter to specify the TfD 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

edit

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

If the discussion type would be rename (move), then normally TfD is not the correct process; use the WP:Requested moves (WP:RM) process, by putting {{subst:Requested move|Template:NewNameHere|reason=Reason for move}} 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. 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}}. In this case, you can also add |otherpage=Template:Whatever to show what rename target has been proposed, though this will only appear in the full-size version of the TfD notice. Also, when |action= is set to a value of rename (or renaming, move, or moving), the help message will suggest leaving people a {{TfR notice}} instead of a {{TfD notice}}.

The |action= parameter does not presently serve any non-rename-related functions, since mergers are handled by {{TfM}}.

Display on articles

edit

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 ([[Template:{{{page}}}|{{{page}}}]]) is being considered for deletion. See [[{{{link}}}|templates for discussion]] to help reach a consensus. ›

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

Module

edit

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:

This module is being discussed in accordance with Wikipedia's deletion policy. Help reach a consensus at [[{{{link}}}|its entry]].

Maintenance use only:
1. [{{fullurl:{{{link}}}|action=edit&editintro=Wikipedia:Templates_for_discussion/editnotice&section=1}} Edit the TfD log] to create the discussion entry.
2. Please consider notifying the author(s) by placing {{subst:TfD notice|Template for discussion/sandbox|module=yes}} ~~~~ on their talk page(s).

Inline

edit

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

edit

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

edit

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

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

which produces:

‹ The template [[Template:{{{page}}}|{{{page}}}]] is being [[{{{link}}}|considered for deletion]]. ›

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

Disabled

edit

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?

edit

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:

Among her favorite fruits were apples, avocados, bananas,

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

dried grapes, oranges, peaches and pears.

Note how this breaks up the paragraph containing the template. Using |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.

|type=tiny would look like this:

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

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.

Deduplication

edit

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 Tfd›apples, ‹See Tfd›avocados, ‹See Tfd›bananas, ‹See Tfd›dried grapes, ‹See Tfd›oranges, ‹See Tfd›peaches and ‹See Tfd›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:

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

Categorisation

edit

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