Brontekst bekijken van Sjabloon:Template for discussion/doc

{{Documentation subpage}}
{{template shortcut|tfd|pre=subst:}}
{{warning|'''Please note:''' The usage of this template has recently changed.}}
{{subst only}}
{{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]].

=== Basic usage ===
Substitute this template onto the template you wish to nominate, i.e. add the following code and press save.
<pre>{{subst:Template for discussion}}</pre>

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

=== 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.

==== 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:
<pre>{{subst:Template for discussion|type=inline}}</pre>
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
<pre>{{subst:Template for discussion|type=tiny}}</pre>
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.
<pre>{{subst:Template for discussion|type=sidebar}}</pre>
which produces:
{{Template for discussion/dated|type=sidebar|demospace=main}}
{{clear}}

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

=== 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||{{Template for discussion/dated|page=Raisins|link=WP:TFD|demospace=main}}Among  her favorite fruits were [[apple]]s,  [[avocado]]s,  [[banana]]s,  [[Raisin|dried grapes]],  [[Orange (fruit)|oranges]],  [[peach]]es  and [[pear]]s.}}
And it is impossible for the reader to identify the template which is under discussion.

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.}}
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  rare cases, where the insertion of any template is deemed too detrimental to a large number of articles, 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 ==
* {{Tl|Tfm}} - the parallel template for merging
* {{Tl|Tfd2}} - second step in a Tfd process
* {{Tl|Tfdnotice}} - Tfd info on related pages
* {{Tl|Catfd}} - Tfd with corresponding category
* {{Tl|Catfd2}} - add corresponding category to second step in a Tfd process

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Templates for discussion templates]]

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