Revision 91 of "Template:Tfm/doc" on wikimaniawiki

{Documentation subpage}}
{{subst only}}
{{Twinkle standard installation}}

This [[Wikipedia:Template namespace|template]] is used to nominate other templates for merging.

=== Usage ===

To nominate a single template, copy and paste the following code at the top of the template:

 {{tlxs|tfm|''OtherTemplate''}}

* Note: ''OtherTemplate'' should be replaced by the name of the other template to be merged, '''excluding''' the prefix <code>Template:</code>.


To nominate multiple templates for merging under the same header, type the following at the top of each individual template:

 {{tlxs|tfm|''OtherTemplate''|3=heading=''NameHeader''}}

where ''NameHeader'' is the name of the [[Help:Section|header]] under which you will list the templates for merging.

=== 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:
{{Tfm/dated|otherpage=OtherTemplate|demospace=main|page={{BASEPAGENAME}}|link=#}}

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:
 {{tlxs|Tfm|''OtherTemplate''|type{{=}}inline}}
The notification on articles looks like this:
{{Tfm/dated|otherpage=OtherTemplate|type=inline|demospace=main|page={{BASEPAGENAME}}|link=#}}

==== Tiny ====
To use even smaller notifications, for inline template nominations, set {{para|type|tiny}}. Type the following
 {{tlxs|Tfm|''OtherTemplate''|type{{=}}tiny}}
which will produce the following notification:
{{Tfm/dated|otherpage=OtherTemplate|type=tiny|demospace=main|page={{BASEPAGENAME}}|link=#}}

==== Sidebar ====
To nominate templates that are used as sidebars, such as infoboxes, specify {{para|type|sidebar}}, i.e.
 {{tlxs|Tfm|''OtherTemplate''|type{{=}}sidebar}}
which produces:
{{Tfm/dated|otherpage=OtherTemplate|type=sidebar|demospace=main|page={{BASEPAGENAME}}|link=#}}
{{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.
 {{tlxs|Tfm|''OtherTemplate''|type{{=}}disabled}}
which outputs nothing at all on article pages.

=== See also ===
* {{tl|Tfd}} - the parallel template for deletion
* {{tl|Tfm}} - basic template
* {{tl|Tfm2}} - second step in a TFD process
* {{tl|Tfmnotice}} - TFD info on related pages

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Merge templates for templates]]
[[Category:Template namespace templates]]
[[Category:Templates for discussion templates]]
}}</includeonly>