Fyrimynd:Tfm/doc

Hetta er ein dokumentatión undirsíða til Fyrimynd:Tfm.
Hon inniheldur kunning um nýtsluna, bólkar og um annað innihald, ið ikki er við í uppruna fyrimynd síðuni.

This template should always be substituted, i.e. use {{subst:Tfm/doc}}.

This 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:

{{subst:tfm|OtherTemplate}}

Note: OtherTemplate should be replaced by the name of the other template to be merged, excluding the prefix Template:.

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

{{subst:tfm|OtherTemplate|heading=NameHeader}}

where NameHeader is the name of the header under which you will list the templates for merging.

Display on articles

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:

‹ Tað verður kjakast um, hvørt fyrimyndin niðanfyri (Tfm) skal leggjast saman við eina aðra. Sí fyrimyndir ið kjakast verður um fyri at hjálpa við til at finna fram til eina semju.›

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

Inline

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:tfm|OtherTemplate|type=inline}}

The notification on articles looks like this: ‹The template Tfm is being considered for merging.›

Tiny

To use even smaller notifications, for inline template nominations, set |type=tiny. Type the following

{{subst:tfm|OtherTemplate|type=tiny}}

which will produce the following notification: ‹Sí Tfm›

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

{{subst:tfm|OtherTemplate|type=sidebar}}

which produces:

‹ The template Tfm is being considered for merging. ›

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

Disabled

Finally it is possible to disable the notification completely by typing |type=disabled. You can use this when everything else fails.

{{subst:tfm|OtherTemplate|type=disabled}}

which outputs nothing at all on article pages.