Template:Templatesnotice/doc

This template (templatesnotice) should be put on all templates that are covered by WP:UW and listed on WP:UTM.

Shortcuts
This template can display up to three shortcut templates. (A shortcut template is a template redirect which editors can use instead of typing out a template's full name. For example, editors can use uw-t1 instead of uw-test1.) To indicate the three redirects, just write the name of the redirect template after the appropriate variable (use just the basic name; for example, "uw-v1" instead of "Template:Uw-v1" or " "). Leave out the parameters that you don't need.

This feature calls template shortcut.

Template series
For easy navigation, it is possible to use user warning set. There are three variables you can use, one of which is required. Another is recommended, and another is only needed if escalation is required. The format for this is: &#123;{templatesnotice|series=series |max=max |escalate=escalate}}
 * series is the name of the template series. This is the prefix of the template. Examples of series names are "uw-vandalism", "uw-test", "uw-spam", "uw-agf".
 * max is the number of templates in the series. For the "uw-own" series, which contains the templates uw-own1, uw-own2, and uw-own3, B would be 3. If all four levels are used, B would be 4. Any values other than "3" or "4" would yield levels 1, 2, 3, 4, and 4im being displayed. Use "4im" for the B value if this is the case.
 * escalate indicates whether the template series escalated to uw-vandalism4. The test series contains the templates uw-test1, uw-test2, and uw-test3, so its B value would be 3. If such edits continue, it would be necessary to use uw-vandalism4 as a level 4 warning, so for the uw-test series, C is set to "yes". Setting it to "true", "false", "no", "oh yeah", or "1" would result in the escalation option not being used.

This feature calls user warning set, and uses complex ParserFunctions to do so.

Shortcuts and series
For shortcuts and series, just set the parameters together, in this order: &#123;{templatesnotice|series = name|max = number|s1 = shortcut|s2 = shortcut|s3 = shortcut|s4 = shortcut|escalate = yes}}

Twinkle use notification
This template automatically adds Twinkle standard installation to templates that transclude it. If an individual template is not used by Twinkle, it can be disabled by yes or similar.

nothankyou
If the template doesn't end in "Thank You", use nothankyou=yes.