Template:Single notice/doc: Difference between revisions
Content deleted Content added
→Parameters: reformat the whole list; document parameter "nocat" |
←Blanked the page Tags: Blanking Reverted |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
|||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> |
|||
This template is used to generate documentation for single-notice user warning templates like {{tl|uw-tilde}}. User warning templates using this documentation template should follow the guidelines set by the [[Wikipedia:WikiProject user warnings|user warnings project]]. |
|||
== Syntax == |
|||
'''All parameters''' |
|||
<pre> |
|||
{{single notice |
|||
| param1 = |
|||
| param1 required = |
|||
| nopage = |
|||
| nothankyou = |
|||
| required named params = |
|||
| extra usage = |
|||
| see also = |
|||
| banners = |
|||
| s1 = |
|||
| s2 = |
|||
| s3 = |
|||
}} |
|||
</pre> |
|||
== Parameters == |
|||
; {{para|param1}} |
|||
:a two-or-three-word description of parameter {{para|1}}, to go inside template examples. ({{para|1}} usually contains the page name of whatever page the message is about.) Defaults to "article". |
|||
; {{para|param1 required}} |
|||
: set to <code>yes</code> if {{para|1}} is required. |
|||
; {{para|nopage}} |
|||
:set to <code>yes</code> if there is no {{para|1}} parameter. |
|||
; {{para|nothankyou}} |
|||
: set to <code>yes</code> if the message does not end in "Thank you." By default, the template will say that additional text set with the {{para|2}} parameter will be used instead of the text "Thank you"; if you set this to <code>yes</code>, the template will instead say that {{para|2}} will be added at the end of the message. |
|||
; {{para|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, <code><nowiki>myparam{{=}}''example value''</nowiki></code> will give the code <code>myparam{{=}}''example value''</code>. |
|||
; {{para|extra usage}} |
|||
:a space to add additional information about usage of the template. |
|||
; {{para|see also}} |
|||
:a space to add "see also" links for the template. |
|||
; {{para|banners}} |
|||
:a space to add banners such as {{tl|Twinkle standard installation}}. |
|||
; {{para|s1}}, {{para|s2}}, {{para|s3}} |
|||
:template shortcuts. |
|||
; {{para|nocat}} |
|||
:[[WP:NOCAT|suppress automatic categorization]] |
|||
==See also== |
|||
* {{tl|Templatesnotice}}: generates documentation for multi-issue user-page templates. |
|||
{{single notice links}} |
|||
<includeonly>{{Sandbox other|| |
|||
<!-- Categories below this line, please; interwikis at Wikidata --> |
|||
[[Category:Documentation shared content templates]] |
|||
}}</includeonly> |
|||