Template:Templates notice/doc

From MOASSpedia
Jump to navigation Jump to search

This template ({{templates notice}}) should be put on all multi-level warning templates that are covered by WP:UW and listed on WP:UTM.

Syntax

All parameters

{{templates notice
| series                = 
| max                   = 
| escalate              = 
| escalate_to           =  
| param1                = 
| nothankyou            = 
| extra_usage           =
| see_also              = 
| notwinkle             =
| noredwarn             =
| s1                    = 
| s2                    = 
| s3                    = 
| s4                    = 
}}

Parameters

  • series - 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 - the number of templates in the series. For the "uw-own" series, which contains the templates {{uw-own1}}, {{uw-own2}}, and {{uw-own3}}, max should be 3. If all four levels are used, max should be 4. Any values other than "3" or "4" would yield levels 1, 2, 3, 4, and 4im being displayed. Use "4im" for the max value if this is the case.
  • escalate - set to yes if the template series escalates to {{uw-vandalism3}} if max=2 or to {{uw-vandalism4}} if max=3. The test series contains the templates {{uw-test1}}, {{uw-test2}}, and {{uw-test3}}, so its max 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, escalate is set to yes.
  • escalate to - use this parameter if max=2 or max=3, escalate=yes, but where the final notification is not {{Uw-vandalism3}} or {{Uw-vandalism4}}. The value of escalate to changes the final level template displayed from {{Uw-vandalism3}} to {{Uw-escalate to3}} or {{Uw-vandalism4}} to {{Uw-escalate to4}}. (Note: The value replaces the word "vandalism" in "Uw-vandalism3" or "Uw-vandalism4"; the "Uw-" at the beginning and the "3" or "4" at the end do not change, so the template's name has to start with "Uw-" and end with "3" or "4".)
  • param1 - a two-or-three-word description of parameter |1=, to go inside template examples. (|1= usually contains the page name of whatever page the message is about.) Defaults to "article".
  • nothankyou - set to yes if the message does not end in "Thank you." By default, the template will say that additional text set with the |2= parameter will be used instead of the text "Thank you"; if you set this to yes, the template will instead say that |2= will be added at the end of the message.
  • extra usage - a space to add additional information about usage of the template.
  • see also - a space to add "see also" links for the template.
  • notwinkle - set to yes if the message is not used in Twinkle. This disables the automatic {{Twinkle standard installation}} placement at the top of the page.
  • noredwarn - set to yes if the message is not used in RedWarn. This disables the automatic {{RedWarn standard installation}} placement at the top of the page.
  • s1, s2, s3, s4 - template shortcuts.

See also