Template:Single notice/doc
 | This is a documentation subpage for Template:Single notice. It may contain usage information, categories and other content that is not part of the original template page. |
This is a meta-template used to generate documentation for single-notice user warning templates like {{uw-tilde}}. User warning templates using this meta-template should follow the guidelines set by the user warnings project.
Syntax
All parameters
Template documentation
Usage: :
This template should always be substituted (i.e., use {{subst:Single notice}}). Any accidental transclusions will be automatically substituted by a bot.{{subst:Single notice}}:{{subst:Single notice|'}}references a specific :{{subst:Single notice|'|Additional text}}adds text onto the end of the message instead of "Thank you" :{{subst:Single notice||Additional text}}or{{subst:Single notice|2=Additional text}}also adds text onto the end of the message instead of "Thank you", but doesn't link a page as specified by the . * This standardized template conforms to guidelines by the user warnings project. You may discuss the visual appearance of these standardized templates (e.g. the image in the top-left corner) at the user warning talk page. * Please refer to the index of message templates before using any template on user talk pages to warn a user. Applying the best template available for your purpose may help reduce confusion from the message you are sending. * Please remember to substitute the template using{{subst:Single notice}}rather than{{Single notice}}. *To give greater detail to your message, you may add the and some additional text to the end of the template. If such or additional text includes a URL or anything which includes an equal sign ("="), it may break the parser's function unless you prefix the or the text with a named template parameter. Use "1=" if the contains an equals sign and use "2=" if the additional text contains an equals sign (such as a URL). *This template automatically populates the relevant category with the user page. If and when the user account gets blocked, or approximately eight weeks pass with no further action, that categorization is automatically removed. *This is the documentation for the {{Single notice}} standardized template, as used by several single-level user warnings or notice templates. It is located at Template:Single notice/inner(edit talk links history).*Parameters
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". *param1 required- set toyesif|1=is required. *nopage- set toyesif there is no|1=parameter. *nothankyou- set toyesif 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 toyes, the template will instead say that|2=will be added at the end of the message. *required named params- use this parameter to add required named parameters to all of the example template invocations. They will be added as the first parameter to Template:Tlsc, so you should escape equals signs. For example,myparam{{=}}''example value''will give the codemyparam=example value. *extra usage- a space to add extra examples of how to use the template. *see also- a space to add "see also" links for the template. *banners- a space to add banners such as {{Twinkle standard installation}}. *s1,s2,s3- template shortcuts.
