Template:Tfr notice/doc

Place this template for rename (TfR) notice on the talk page of interested parties, such as the nominated template's creator. In the case of a popular or significant template, it may be appropriate to give wide notice.

Usually, templates are renamed (moved) through same Wikipedia:Requested moves (WP:RM) process as other pages, so {{subst:Rm}} is the template normally used. However, sometimes some template renames are proposed as part of a broader spate of template cleanup that also involves deletions and/or mergers, in which case it makes more sense to include the renames with the related deletions/moves at WP:TFD, to centralize the discussion.

Usage

Copy and paste the following code on user talk pages to inform editors of the discussion:

{{subst:Tfr notice|CurrentTemplateName|NewTemplateName}} ~~~~

• Note: CurrentTemplateName and NewTemplateName represent templates' names excluding the prefix Template: (or Module:).
• "Template:" will be added by default. For modules, see below.

RM versus TfD

Most template rename discussions are via WP:RM process, and take place at the template's (or module's) talk page. This is the default. The template will tell people to see the talk page, and will create a link to an RM discussion on the talk page with today's date, unless it has to be backdated with the |days= parameter, or completely overridden with |3= AKA |talk= or |discuss=.

If the discussion is at WP:TFD, then use |tfd=y to set this, and it will instead generate a link to today's TfD log, at a section named for the template being moved (CurrentTemplateName in the example above), unless overriden one of those same two ways.

Parameters

• |1= or 1st unnamed parameters is the required template/module proposed for renaming; just the base pagename without "Template:" or "Module:".
• |2= or 2nd unnamed parameter is the required new name proposed for the template/module; just the base pagename without "Template:" or "Module:".
• |3= or 3rd unnamed parameter or |discuss= or |talk= is the optional custom name of the discussion section to link to; this is the part of the link after the # character.
  • The default (for RM) is "Template/Module talk:CurrentTemplateName#Requested move D[D] Monthname YYYY"; the underlined part is what this parameter can change. This is of use if the RM discussion was created with {{subst:Rm|...|heading=Something custom here}}.
  • The default if |tfd=y is set is "Wikipedia:Templates for discussion/Log/YYYY Monthname D[D]#CurrentTemplateName; the underlined part is what this parameter can change. This is of use in the case of a group TfD with a genericized title like "Various geographical coordinate templates".
  • The date in either of those can be set back 1 or more days with |days=, below.
  • This has nothing to do with the heading created on the user talk page by this notice you are leaving; see |heading=, below.
• |days= is the number of days before the current date in which the pagenames were listed at WP:RM or the TfD log. For example, if the page was listed yesterday on the log, then |days=1 would be used. If the page was listed on the log three days before today, then |days=3 would be used. Leave blank if listed the same day as you are leaving this notice.
  • This parameter will tweak dates in either the default RM mode or in |tfd=y mode; however, |3= AKA |discuss= or |talk= will make this parameter do nothing if used in RM mode, since the date is part of the #Link that gets replaced. Both parameters do work in tfd mode.
• |tfd=yes (or |tfd=y or any other value) changes the template from WP:RM behavior to WP:TFD behavior, as described above (this mostly affects the link to the discussion).
• |module=Module: (or |module=y or any other value) changes the namespace of the pagenames in question to Module: instead of Template:.
• |heading=no (or any other negative value such as |heading=false, |heading=0) will suppress the creation of a new talk-page heading for this notice. Can also be specified as |header=no.
  • |heading=3 or |header=3 will change the default second level (==) heading to a third-level (subsection) heading. This is useful when dropping off a series of such notes if you want to group them under a single main heading. This parameter option is, of course, mutually exclusive with |heading=no.
  • This has nothing to do with the heading of the discussion being linked to; see |3=, above.

See also

• {{subst:Tfd notice}} – the parallel template for deletion notices
• {{subst:Tfm notice}} – the parallel template for merger notices
• {{subst:Tfr}} – basic template for TfR (use at the template)
• {{subst:Tfr2}} – second step in a TfR process (use at WP:TFD)