View source for Template:Template for discussion/doc

{{Documentation subpage}}
{{template shortcut|tfd|pre=subst:}}
{{subst only}}
{{Twinkle standard installation}}
{{XFDcloser standard installation}}
{{Wikipedia:Article alerts/Bot use warning}}
{{warning|Substituting this template creates a dated version, you '''should not''' substitute the dated version.}}
This template is used to nominate a [[Wikipedia:templates for discussion|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.
<syntaxhighlight lang="wikitext">{{subst:Template for discussion}}</syntaxhighlight>

or

<syntaxhighlight lang="wikitext">{{subst:TfD}}</syntaxhighlight>

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 {{t|TPER}}.

=== Nominating a group of templates ===
To nominate multiple templates for deletion under the same heading, use the {{para|heading}} (AKA {{para|header}}) parameter to specify the TfD heading under which the discussion is taking place. Type the following at the top of each individual template:
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|heading=HEADING}}</syntaxhighlight>
where {{var|HEADING}} is the name of the [[Help:Section#Headings|section heading]] under which you will list the templates for deletion.

=== Changing the discussion type ===
If the discussion type is ''merger'', use template {{tlxs|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 {{tlxs|Requested move|Template:<var>NewNameHere</var>|3=reason=Reason for move}} on the template's {{strong|talk}} page.

The parameter {{para|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 {{para|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 {{para|action|rename}} in the TfD tag for the template to be moved, e.g.: {{tlxs|TfD|action{{=}}rename}}. In this case, you can also add {{para|otherpage|Template:{{var|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 {{para|action}} is set to a value of {{kbd|rename}} (or {{kbd|renaming}}, {{kbd|move}}, or {{kbd|moving}}), the help message will suggest leaving people a {{tlx|TfR notice}} instead of a {{tlx|TfD notice}}.

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

=== Display on articles ===
Unless you do something unusual such as enclosing in [[WP:NOINCLUDE|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:
{{Template for discussion/dated|demospace=main}}

There are various other options, specified by the {{para|type}} parameter.

==== Module ====
To nominate a [[Help:Module|module]], set {{para|type|module}}, add the substituted template to the <code>/doc</code> page. Type the following:
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|type=module|page={{subst:BASEPAGENAME}}}}</syntaxhighlight>
at the top of the module's <code>/doc</code> subpage.  The notification looks like this:
{{Template for discussion/dated|type=module|bigbox=yes|demospace=main}}

==== Inline ====
To nominate [[:Category:Inline templates|inline templates]], set {{para|type|inline}}. This will help with formatting issues that occur when the large notification is displayed. Type the following:
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|type=inline}}</syntaxhighlight>
The notification on articles looks like this:
{{Template for discussion/dated|type=inline|demospace=main}}

==== Tiny ====
To use even smaller notifications, for inline template nominations, set {{para|type|tiny}}. Type the following
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|type=tiny}}</syntaxhighlight>
which will produce the following notification:
{{Template for discussion/dated|type=tiny|demospace=main}}

==== Sidebar ====
To nominate templates that are used as sidebars, such as infoboxes, specify {{para|type|sidebar}}, i.e.
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|type=sidebar}}</syntaxhighlight>
which produces:
{{Template for discussion/dated|type=sidebar|demospace=main}}
{{clear}}
You can alternatively use {{para|type|infobox}} or {{para|type|box}} to produce the same result.

==== Disabled ====
Finally it is possible to disable the notification completely by typing {{para|type|disabled}}. You can use this when everything else fails.
<syntaxhighlight lang="wikitext">{{subst:Template for discussion|type=disabled}}</syntaxhighlight>

=== Which type should be used? ===
For example, suppose that a  template called {{Tl|Raisins}} outputs the link "[[Raisin|dried grapes]]". Here's how it might appear in  an article:
{{divbox|navy||Among  her favorite fruits were [[apple]]s,  [[avocado]]s,  [[banana]]s,  [[Raisin|dried grapes]],  [[Orange (fruit)|oranges]],  [[peach]]es  and [[pear]]s.}}
If  the default type were to be inserted into the  template, the following would result:
{{divbox|navy||Among  her favorite fruits were [[apple]]s,  [[avocado]]s,  [[banana]]s,  {{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main}}[[Raisin|dried grapes]],  [[Orange (fruit)|oranges]],  [[peach]]es  and [[pear]]s.}}
Note how this breaks up the paragraph containing the template. Using {{para|type|inline}} instead generates the following result:
{{divbox|navy||Among her  favorite fruits were [[apple]]s,  [[avocado]]s,  [[banana]]s,  {{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main|type=inline}}[[Raisin|dried grapes]], [[Orange (fruit)|oranges]],  [[peach]]es  and [[pear]]s.}}
{{para|type|tiny}} would look like this:
{{divbox|navy||Among her  favorite fruits were [[apple]]s,  [[avocado]]s,  [[banana]]s,  {{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main|type=tiny}}[[Raisin|dried grapes]], [[Orange (fruit)|oranges]],  [[peach]]es  and [[pear]]s.}}
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===
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 {{para|dedup|no}}.

For example, by default a sentence might appear as
{{divbox|navy||Among her  favorite fruits were {{Template for discussion/dated|page=Apples|link=WP:TFD|demospace=main|type=tiny}}[[apple]]s,  {{Template for discussion/dated|page=Avocados|link=WP:TFD|demospace=main|type=tiny}}[[avocado]]s,  {{Template for discussion/dated|page=Bananas|link=WP:TFD|demospace=main|type=tiny}}[[banana]]s,  {{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main|type=tiny}}[[Raisin|dried grapes]], {{Template for discussion/dated|page=Oranges|link=WP:TFD|demospace=main|type=tiny}}[[Orange (fruit)|oranges]],  {{Template for discussion/dated|page=Peaches|link=WP:TFD|demospace=main|type=tiny}}[[peach]]es  and {{Template for discussion/dated|page=Pears|link=WP:TFD|demospace=main|type=tiny}}[[pear]]s.}}
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 {{para|dedup|no}}:
{{divbox|navy||Among her  favorite fruits were {{Template for discussion/dated|page=Apples|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[apple]]s,  {{Template for discussion/dated|page=Avocados|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[avocado]]s,  {{Template for discussion/dated|page=Bananas|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[banana]]s,  {{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[Raisin|dried grapes]], {{Template for discussion/dated|page=Oranges|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[Orange (fruit)|oranges]],  {{Template for discussion/dated|page=Peaches|link=WP:TFD|demospace=main|type=tiny|dedup=no}}[[peach]]es  and {{Template for discussion/dated|page=Pears|link=WP:TFD|demospace=main|type=tiny}}[[pear]]s.}}

=== Categorisation ===
Templates that transclude this template will be added to [[:Category:Templates for deletion]].

== See also ==
* {{tlxs|Tfm|{{var|OtherTemplateName}}}} – the parallel template for merging
* {{tlxs|Tfd2}} – second step in a Tfd process (use at [[WP:TFD]] daily log page)
* {{tlxs|Tfd notice}} – to leave a notification at the template creator's talk page or other relevant pages
* {{tlxs|Catfd}} – TfD with corresponding category (use at the category; categories are otherwise normally deletion-tagged with {{tlxs|Cfd}})
* {{tlxs|Catfd2}} – add corresponding category to second step in a TfD process (use at [[WP:TFD]] daily log page; categories are otherwise normally deleted via [[WP:CFD]])
* {{tlxs|Old TfD}} – document results of TfD on a talk page
* {{tlxs|Sfd-t}} – to delete a stub template
<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Templates for discussion templates]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
}}</includeonly>